Improvements to navigability and readability to documentation #9
Description
Navigating and interacting with our current Dokku deployment guide reveals room for improvement - larger changes to it would necessitate discussion at the L10 or WebDev Curriculum Committee, but I can see a series of small efforts that would improve navigability and readability:
- Immediately linking the reader at the bottom of ‘All in one deployment’ guide to the ‘Environment Variables’ and ‘Database Management’ guide under a heading above Conclusion labeled ‘suggested next steps’
- Renaming “Basic Deployment Concepts” to “Deployment Concept FAQs” for better intention of the document
- Inside the “Deployment Concept FAQs”, renaming the last two headings to be questions to following the intent of the document [Domains > “What is a domain?“; Dokku > “What is dokku?“]
- Moving the “Deployment Concept FAQs” above the All in one guide to indicate the introductory nature of the concepts within precede the other guides
- Renaming “FAQ” to something along the lines of “We’re deployed - now what?” or folding it into “All in One” deployment guide to actually make that an “All in One” guide