Skip to content

Google Docs: Current Structure of Guides

Ethan-Strominger edited this page Nov 19, 2023 · 1 revision

Currrent Structure

Unstructured. Top level has folders for different project areas. No separation between production and non-production versions. Some are subfolders, others are shortcuts.

image

New Structure

  • production
    • TBD
  • in review
    • TBD

A production folder for production version of documents and an in-process folder for documents being drafted, revised, or viewed. The two directories will be at the top level under an existing HackForLA folder. System will only read actual subfolders, shortcuts will be ignored. If particular content has to be stored in a folder that cannot be put under the in-review folder then that content will not be rendered in markdown until it is copied to production.

An authorized user will be able to specify which github repository a document is pushed to and the web slug for the document. The web slug determines the github directory and github filename which in turn is used in the url for the document. There will be one repository for production and any number of repositories as desired for in review.