Order from Chaos

Project Management and Documentation, Part 2

Now, following Griffin Orsinger and Adam Stone

Week 1 - Project Management - Griffin Orsinger Fab Academy

MkDocs - Adam Stone Fab Academy Documentation

  • Installing MKdocs
    • Installing python to install mkdocs from WinStore #screenshot
    • clearly pip is not installed #screenshot
    • i don’t trust the microsoft store so downloading from site
    • installing - pip and PATH checked
    • following Adam Stone closely - MKDocs is operational and basic site is working
      • installed MKDocs
      • mkdocs.yml updated
      • week1.md etc created
      • Now to choose a Theme - Oh Lord.
      • went to mkdoc documentation after running out of Adam’s
        • everything checks out, I’ve generally understood what’s happening
        • not bothering with curl instead I’m operating and creating new files within atom only
        • ooh, I like readthedocs. Atleast in terms of function, but looks very generic
        • [] toDo : change favicon at some point
        • went through the themes
          • Gitbook was installed
          • https://gitlab.com/lramage/mkdocs-gitbook-theme
          • downloaded Cinder but it seems like a non-standard installation so will mess with it later
          • sticking to ivory for now, Gitbook is showing some missing links on the mage footer
    • Back to Adam Stone + MKDocs documentation, now to create the site
    • taking a break. dinner time.

To Do :

  • Images insert
    • VSCode allows direct drop
    • Atom Plugin
    • do I finally give up Atom and get to VSCode ?
    • better template eventually ?
    • OR refactor this whole thing - split the TL;DR instructions-for-replication vs the stream-of-thought text ?

Conclusion

MKDocs :

MKDocs is working fine, it's serving all my MD pages well on the internal server.
However, it is not working when uploaded to the FabLab GitLab repo.

GitLab :

The SSH key was also generated and entered. GUI for GitLab was installed. The repo has been successfully cloned, so that means the SSH Key is valid, and communication with the web is active.

However, uploading the MD files was not really working, and pages were not being generated.