Ways to make the documentation process easier for GitLab users
https://twitter.com/JenMcdaid/status/1054752814277124097
At GitLab, we have configured a static site generator to build markdown files from our repo into a static site, hosted by GitLab Pages. Wikis are also a popular feature for documentation. How can we enhance these features and others to better support common documentation workflows?
Consider the challenges faced by people who write the docs:
- Ensure feature changes come with documentation changes
- Managing issues and MRs: there are challenges/risks if doc work shares the issue and/or MR, and if it doesn't
- The authoring and previewing process itself, when editing markdown in GitLab
- It can be hard to keep tabs on the heading structure of the doc and where I currently am; whether the relative heading levels are making sense. etc. Could be remedied with a WYSIWYG editor (which would also bring other benefits)
- Content reviews
- Server-side things (that aren't possible with GitLab Pages today): Site stats, monitoring 404s, adding redirects, etc.
More use cases and potential solutions needed.
Edited by Mike Lewis