Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Set up mkdocs site in PD #166

Closed
7 tasks done
Tracked by #185
fyliu opened this issue Jun 12, 2023 · 3 comments · Fixed by #231
Closed
7 tasks done
Tracked by #185

Set up mkdocs site in PD #166

fyliu opened this issue Jun 12, 2023 · 3 comments · Fixed by #231
Assignees
Labels
complexity: missing feature: docs: team guide Same as PD team documentation? role: dev lead s: PD team stakeholder: People Depot Team size: 2pt Can be done in 7-12 hours

Comments

@fyliu
Copy link
Member

fyliu commented Jun 12, 2023

Overview

We need to convert our docs to use the mkdocs documentation generator. It will make it easier to work on documentation. This issue should be done as simply as possible without adding the bells and whistles.

Action Items

Resources/Instructions

@fyliu fyliu added size: 1pt Can be done in 4-6 hours role: missing s: PD team stakeholder: People Depot Team feature: docs: team guide Same as PD team documentation? labels Jun 12, 2023
@fyliu fyliu added this to the 5 - Team Workflow milestone Jun 12, 2023
@fyliu fyliu added size: 2pt Can be done in 7-12 hours role: dev lead and removed size: 1pt Can be done in 4-6 hours labels Jun 12, 2023
@fyliu
Copy link
Member Author

fyliu commented Jul 20, 2023

I've actually been working on this one and I created a docker config to build an image so our devs won't have to install mkdocs on their own machines. But I realized it can work for all the other teams using mkdocs at hfla, so I went to set up the docker-mkdocs repo for that purpose. I'm planning to finish that soon and then make our setup just download that image rather than build it ourselves.

This should be very fast once I come back to it.

@fyliu fyliu self-assigned this Aug 11, 2023
@fyliu fyliu removed their assignment Aug 23, 2023
@fyliu fyliu self-assigned this Sep 7, 2023
@Neecolaa

This comment was marked as resolved.

@fyliu
Copy link
Member Author

fyliu commented Dec 6, 2023

I've been working on this and the current progress is this:
https://fyliu.github.io/peopledepot/tools/mkdocs/

I also accidentally pushed the changes to hackforla/main for a short time before reverting that history. So the same docs are also hosted at https://hackforla.github.io/peopledepot/tools/mkdocs/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
complexity: missing feature: docs: team guide Same as PD team documentation? role: dev lead s: PD team stakeholder: People Depot Team size: 2pt Can be done in 7-12 hours
Projects
Status: ✅Done
Development

Successfully merging a pull request may close this issue.

3 participants