Create handbook development SSoT, sync tools with public handbook
Problem to solve
The public and internal handbook are in a different documentation state for the local dev setup. Contributors have a hard time figuring out how to run Hugo locally, and make larger changes without waiting for CI/CD pipelines.
CI/CD and linters are not documented.
General Docsy Theme development and dependency update workflows for maintainers are not documented.
TL;DR - contributing and maintaining the handbook is not efficient.
Changes
- Create
/docs/development
documentation as SSoT for all handbooks (their development does not differ much). All changes are tested and verified.- How to run Hugo locally - Docker, and source installation
- Dependency updates
- Theme development
- Redirects
- CI/CD
- Review apps
- Linting
- Reviewer Roulette
- CI/CD
- Bump Hugo image to 0.123.7, markdownlint2 to
0.12.1
(same as other handbooks)
- Bump Hugo image to 0.123.7, markdownlint2 to
- Tools
- Add Makefile
- Add Vale config
- Update default config version to Hugo 0.123.7
related to https://gitlab.com/gitlab-com/content-sites/internal-handbook/-/issues/80
fixes #4 (closed)
Edited by Michael Friedrich