|
| 1 | +[[ADR-0001]] |
| 2 | += ADR-0001: How We Want to Handle Versions in Our Documentation |
| 3 | + |
| 4 | +[cols="h,d",grid=rows,frame=none,stripes=none,caption="Status",%autowidth] |
| 5 | +|==== |
| 6 | +// Use one of the ADR status parameter based on status |
| 7 | +// Please add a cross reference link to the new ADR on 'superseded' ADR. |
| 8 | +// e.g.: {adr_suposed_by} <<ADR-0000>> |
| 9 | +| Status |
| 10 | +| PROPOSED |
| 11 | + |
| 12 | +| Date |
| 13 | +| 2020-10-12 |
| 14 | + |
| 15 | +| Author(s) |
| 16 | +| Yannik Fuhrmeister <yannik.fuhrmeister@iteratec.com> |
| 17 | +// ... |
| 18 | +|==== |
| 19 | + |
| 20 | +== Context |
| 21 | + |
| 22 | +We want to introduce versioning to be able to provide dokumentation for multiple versions of the SecureCodeBox. |
| 23 | +The tool that we are currently using for documentation is https://v2.docusaurus.io/[Docusaurus]. |
| 24 | +Docusaurus provides the possibility to maintain multiple versions out of the box (https://v2.docusaurus.io/docs/versioning/[]). |
| 25 | + |
| 26 | +We will need to specify how many versions of the documentation we want to maintain to avoid inconsistencies and overhead. |
| 27 | +Furthermore, we need to decide which version increments need to have their own branch of documentation. |
| 28 | + |
| 29 | +== Decision |
| 30 | + |
| 31 | +* We introduce a new documentation version for every minor version (https://semver.org/[]) to ensure that the documentation is up to date |
| 32 | +* We maintain the latest 3 major versions (previous, current, next) |
| 33 | +* We maintain the latest minor version for each major version |
| 34 | +* We *do not* maintain patch versions nor multiple minor versions for each major version! |
| 35 | +* *Example:* For SecureCodeBox versions `1.9.9`, `2.3.2`, `2.3.3` and `3.0.0` the documentation versions would be `1.9.x`, `2.3.x` and `3.0.x` |
| 36 | +* *TL;DR* We maintain 3 versions of the documentation |
| 37 | + |
| 38 | +== Consequences |
| 39 | + |
| 40 | +* We need to update the documentation version everytime we increment minor or major versions of the SecureCodeBox (manually or with action) |
| 41 | +* Maintaining the documentation could be more difficult due to now increased number of documentation files |
| 42 | +* Documentation has to be maintained in two repositories because when creating a new version Docusaurus creates a copy of all files in this respository (see https://v2.docusaurus.io/docs/versioning/#directory-structure[]) |
| 43 | + |
0 commit comments