Update Documentation

[kekoziar]

Documentation

• [ ] How URLSs to outbound links are formatted so clicks are captured by google analytics
• [x] Overall archiving process (including wayback machine)
• [ ] Expand Bootstrap, YAML, and Liquid references to include where liquid actually comes from, how it integrates with github
• [ ] Larger organization, permissions, policy, etc
• [x] Add specific directions, including known issues, on how to run locally
• [ ] How files are interconnected.
• • [x] _data : yml files
• • [x] _layouts : standard page layouts
• • [x] _includes : header, footer, repeatable code chunks
• • [x] _YYYY_pages : pages
• • [ ] Html pages in _YYYY_pages give base structure to build live pages.
• • [ ] Layout refers to file in _layouts
• • [x] Permalink give URL
• • [ ] Title is page title
• • [ ] Use liquid for includes and repeatable structure
• [ ] Google analytics

[kekoziar]

Investigate & document

• [ ] does the --incremental flag rebuild and restart the site every time an edit is made, or does auto-regeneration handle that?

[devnich]

We currently have some documentation in the Wiki, and some in the README. Do we want to consolidate the docs in one place? Or do they serve complimentary functions?

[kekoziar]

I think they should be complementary. The README right now is the documentation that came with the theme, but it's out of date because the site has been customized to UCLDW. Perhaps the README can have how to install and run locally, and the wiki will have more in-depth information, such as UC branding info, file structure, backup procedures, accessibility guidelines, etc.

[stephlabou]

@wdahdul

[stephlabou]

• [x] add reference to Feedme.md to main wiki (documentation for JSON feed builder)

[stephlabou]

• [x] update main README to be more relevant (links to wiki and how to run locally, etc.)

[stephlabou]

Much of this is in wiki updated July 2024