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/