Skip to content

Commit 08e899d

Browse files
committed
Propose ADR to drop documentation versioning
Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>
1 parent 0e27d5c commit 08e899d

1 file changed

Lines changed: 34 additions & 0 deletions

File tree

‎docs/adr/adr_0008.md‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
<!--
2+
SPDX-FileCopyrightText: 2020 iteratec GmbH
3+
4+
SPDX-License-Identifier: Apache-2.0
5+
-->
6+
7+
# ADR-0008: Drop the Former Decision To Provide Versioned Documentation
8+
9+
| <!-- --> | <!-- --> |
10+
|----------------|----------|
11+
| **Status**: | PROPOSED (will SUPERSEDES [ADR-0006](ADR-0006.md)) |
12+
| **Date**: | 2021-07-15 |
13+
| **Author(s)**: | Sven Strittmatter <sven.strittmatter@iteratec.com> |
14+
15+
## Context
16+
17+
In [ADR-0006](ADR-0006.md) we decided to provide and maintain versions according to the major and minor versions of the _secureCodeBox_. Until now we never respected this decision on only provided a HEAD revision of the documentation. Since we have the plan to to a major breaking update to the _secureCodeBox_ we have the urge to decide if we want to version our documentation or not because we **must** make breaking changes to the documentation, so that it will not match older versions of _secureCodeBox_.
18+
19+
## Decision
20+
21+
**We do not provide any versions of the documentation!**
22+
23+
But we tag the documentation repository for **major version increments**, so that one looking for older documentation can checkout an older version.
24+
25+
### Justification
26+
27+
- We do not want to invest the work to maintain more than the current version of the documentation.
28+
- We do not want to encourage our customers to **not upgrading** _secureCodeBox_.
29+
- We do not want to confuse our customers with old documentation maybe linked somewhere or preferred in search results.
30+
31+
## Consequences
32+
33+
- Someone using an old major version will have incompatible documentation. We strongly advise them to update always to the latest version.
34+
- Someone using an old minor version will have features documented not available. We strongly advise them to update always to the latest version.

0 commit comments

Comments
 (0)