Contributing to the Documentation¶
Documentation website¶
General guidelines¶
Documentation changes should generally be developed off master (a hotfix or feature). You should check in on the #cdmsbats channel before starting.
Rarely, if you are updating documentation based on new features on develop - like updated build instructions for a new build system - you should develop your documentation off develop (a feature).
Releasing documentation quickly is critical. Prefer frequent documentation releases. Because cdmsbats version follow semantic versioning, a documentation release increments the lowest number.
As always, if you are working with others on changes, you should git pull frequently. If you are unsure how to do this you should contact the package managers.
Procedure¶
Any commit to cdmsbats hotfix or feature branch should first be merged to the existing documentation feature branch: feature/cdmsbats_documentation. When you pushed the updated feature/cdmsbats_documentation feature branch to the remote server (aka. GitLab), a pipeline will be triggered to rebuild the documentation website. Typically that will take ~6 mins because it also runs auto-unit testing.
When you are happy with the documentation changes, follow the procedure to create a merge request: confluence link