Documentation Distribution
Below you can find the overview of all the sections/subsections. Please update this as the documentation evolves so that the distribution/overview is kept up-to-date.
Ideally Operations
and Development
are written by different groups of people. They should be decoupled from each other as much as possible. In the event that these sections need to refer to each other (just a "for more information see .." is fine), we should be careful about this and discuss these cases.
I would propose to work with small feature branches:
- Each subsection/page gets its own branch.
- Branches should be kept small and independent.
- Branches should be merged frequently into
master
.
When working on a subsection:
- Create a branch with the name of the subsection (e.g.
dev-contributing-coding-conventions
). - Make the changes. When you are using content from the
deprecated
directory, make sure to remove the content fromdeprecated
once it is integrated. This way we have an overview of whichdeprecated
pages have not yet been integrated in the documentation. - Once done, create a merge request. Please tag me (@nbugel) on any merge requests so that I can have a quick look over it (seeing as I am new; if things are not clear I might be able to spot them quickly and that way I also get a change to read over the docs)
An edit button is also available on every page. Try to use this only for small changes/fixes.
The main three sections: Overview
, Operations
, and Development
are assigned to @mdavis, @jleduc, and @afonso respectively. It is up to them to assign people to be responsible for the specific subsections there. Of course, feel free to add/remove subsections as required (just be sure to update the overview below). If you want to work on a specific subsection/page, discuss with the person responsible for the section and update the overview below.
People assigned to a subsection/page are expected to ensure that these pages are also kept up-to-date in the future. Of course we can do a slight redistribution of the responsibilities after the initial version of the new documentation is done.
Related: