Updating Documents

Now that we have a document, it needs to stay up to date. This is the role of the Shepherd.

This could look something like this:

• New branch or work on main

• Write docs in ReStructuredText

• Create Merge Request

• Review

• Merge

• Automatically trigger a new build of the docs

• At some point a new branch

• Versioning

Versioning

A document should be assessed at least once a year. It could be that the assessment leads to no change. If a document does lead to a new change, the document version should be updated. This can be a gitlab tag. Read the Docs has support of versioned documents.