Updating Wiki: Install MkDocs

[blulady]

Dependency

• Updating Wiki: Creating a Repo #3634

Overview

We need to install MkDocs into the new repository so that we can start to move the content from old wiki to new wiki

Action Items

• research MkDoc requirements
• make a record of the research/requirements and choose a place in the wiki to keep the research
• read the documentation on MkDocs for any additional info you might need to install (and update our documentation with the steps/choices)
• install MkDocs in the repository listed under Resources/Instructions
• once MkDocs have been installed in the repository
  • Move issue Updating Wiki: Move Current Wiki to New Repository #3636 to New Issue Approval column and remove the Dependency label
  • post the link to the research/requirements under Resources/Instructions in issue Updating Wiki: Move Current Wiki to New Repository #3636

Resources/Instructions

• new repo: https://github.com/hackforla/website-wiki
• https://www.mkdocs.org/

Themes for mkdocs

• Material for MkDocs is a theme for MkDocs, a static site generator geared towards (technical) project documentation.
• Jekyll Doc is a documentation theme for Jekyll.

Article comparing MK Docks vs Jekyll for WIKI

• MkDocs or Jekyll for Technical Documentation - we decided to go with mkdocks

Examples

The Youth Justice Nav Project's documentation currently uses Material for MkDocs.

• Youth Justice Nav repo
• Youth Justice Nav documentation static site

GreenearthOS uses Mkdocks without material

• https://www.greenearthos.org/

other stuff

• notes
• audit spreadsheet
• Example of another mkdocks install https://brigade.cloud/projects/

[github-actions]

Hi @t-will-gillis, thank you for taking up this issue! Hfla appreciates you :)

Do let fellow developers know about your:-
i. Availability: (When are you available to work on the issue/answer questions other programmers might have about your issue?)
ii. ETA: (When do you expect this issue to be completed?)

You're awesome!

P.S. - You may not take up another issue until this issue gets merged (or closed). Thanks again :)

[t-will-gillis]

Availability: 10-12 daily most days
ETA: tbd

[ExperimentsInHonesty]

@t-will-gillis Please move this issue into the in progress column

[ExperimentsInHonesty]

I installed the following files into website-wiki
/mkdocks.yml
/workflow/ci.yml
/docs/index.md (just a place holder to open the directory)

And I changed the following items in Settings

[ExperimentsInHonesty]

This is what it looks like now https://hackforla.github.io/website-wiki/

[JessicaLucindaCheng]

@t-will-gillis Bonnie installed MkDocs last night to the website-wiki repo but she said it still needs to be configured. See Bonnie's comments:

• Updating Wiki: Install MkDocs #3635 (comment)
• Updating Wiki: Install MkDocs #3635 (comment)

[t-will-gillis]

1. Progress: Researching MkDocs, which Bonnie has already installed.
2. Not blockers, but for clarification:

• Documentation: is this meant to be a description of what has been done already- how to install MkDocs or something more along lines of https://github.com/codeforamerica/brigade-project-index/blob/master/docs/docs.md
• Additional info needed- is this referring to formatting options via the mkdocs.yml file, such as navbars, tocs, extensions, features, etc.? Is there a direction we want to head, for example https://github.com/codeforamerica/brigade-project-index/blob/master/mkdocs.yml

3. Availability: most days 11-3
4. ETA: targeting by Friday 17 March

[JessicaLucindaCheng]

@t-will-gillis I found some problems with the Readme.md, so I am reopening this issue.
See my review here: hackforla/website-wiki#2 (review)

[t-will-gillis]

@JessicaLucindaCheng Got it- will take care of these comments a little later today, eta 6 pm