There are 2 types of the documentation that DrevOps provides:
- This Documentation of DrevOps that is then deployed to https://docs.drevops.com/
- Consumer site documentation that is distributed when DrevOps is installed.
The Documentation (this site) is written in Markdown and located in
.drevops/docs directory. This is
removed when you install DrevOps for a
Parts of the documentation is generated automatically from the codebase. To update it, run:
composer -d .drevops/docs/.utils install
If you have the documentation site running locally, the updates will be seen immediately.
Check spelling and links¶
If required, add spelling exclusions to
An automated CI build publishes this documentation to https://docs.drevops.com/:
- on DrevOps release as a tag number
- on every push to
main branch as
- on every commit to a branch that has
docs string as a safe branch name
Consumer site documentation¶
DrevOps provides a scaffold of the consumer site documentation in the
After DrevOps is installed into the consumer site, these docs are intended to be used by the site maintainers and stay up-to-date with the project changes.
See Documentation section.