Skip to content

Propose ADR to drop documentation versioning #542

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Weltraumschaf merged 2 commits into from
Jul 26, 2021
Merged

Propose ADR to drop documentation versioning #542

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
08e899d
Propose ADR to drop documentation versioning
Weltraumschaf Jul 15, 2021
ddd6082
Update docs/adr/adr_0008.md
Weltraumschaf Jul 22, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions docs/adr/adr_0008.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
<!--
SPDX-FileCopyrightText: 2020 iteratec GmbH

SPDX-License-Identifier: Apache-2.0
-->

# ADR-0008: Drop the Former Decision To Provide Versioned Documentation

| <!-- --> | <!-- --> |
|----------------|----------|
| **Status**: | PROPOSED (will SUPERSEDES [ADR-0006](ADR-0006.md)) |
| **Date**: | 2021-07-15 |
| **Author(s)**: | Sven Strittmatter <sven.strittmatter@iteratec.com> |

## Context

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_.

## Decision

**We do not provide any versions of the documentation!**

But we tag the documentation repository for **major version increments**, so that one looking for older documentation can checkout an older version.

### Justification

- We do not want to invest the work to maintain more than the current version of the documentation.
- We do not want to encourage our customers to **not upgrading** _secureCodeBox_.
- We do not want to confuse our customers with old documentation maybe linked somewhere or preferred in search results.

## Consequences

- Someone using an old major version will have incompatible documentation. We strongly advise them to update always to the latest version.
- Someone using an old minor version will have features documented not available. We strongly advise them to update always to the latest version.
- We need to introduce a development branch to ensure that breaking changes are not visible on the site as long as it is not merged in the dev repository