22Documentation about documentation
33=================================
44
5- This repository will contain information that anybody
6- maintaining Open Telekom Cloud documentation need to know.
5+ This repository contains information that maintainers of the Open
6+ Telekom Cloud documentation need to know.
7+
78
89Working in the Open
910===================
1011
1112The Open Telekom Cloud values transparency as a main principle.
12- Therefore, all public facing documentation is maintained in the
13- open, by open-source components. All steps of the process are
14- publicly visible and transparent. This eases the collaboration
15- of our suppliers, OTC staff, and even customers or users. All
16- can propose changes, all can participate in the review process,
17- and each team can appoint arbitrary persons to approve changes,
18- ensuring the integrity of the overall documentation. All changes
19- are recorded and archived, so changes can be rolled back, and
20- audit trails are available even for the tiniest change.
13+ Therefore, all public facing documentation is maintained in the open,
14+ by open-source components. All steps of the process are publicly
15+ visible and transparent. This eases the collaboration of our
16+ suppliers, OTC staff, and even customers or users. All can propose
17+ changes, all can participate in the review process, and each team can
18+ appoint arbitrary persons to approve changes, ensuring the integrity
19+ of the overall documentation. All changes are recorded and archived,
20+ so changes can be rolled back, and audit trails are available even for
21+ the tiniest change.
22+
2123
2224Responsibilities and Ownership
2325==============================
2426
2527The content of the projects is owned by the Open Telekom Cloud Squads
2628responsible for the services respectively. Each team can appoint one
27- or several Squad members (or external contributors, if
28- suitable). Typically, one documentation lead and a deputy are
29- recommended, but other setups are also possible.
29+ or several Squad members (or external contributors, if suitable).
30+ Typically, one documentation lead and a deputy are recommended, but
31+ other setups are also possible.
3032
3133All assets in the repository are public visible, and so are the PRs or
3234the review messages themselves. That’s why sensitive data like
@@ -48,6 +50,7 @@ was initiated by the Ecosystem Squad. It was presented to the Product
4850Owner Community and during the XXXXXXXXXXX meeting/call/board. It was
4951approved on November XX, 2021 as authoritative by the board.
5052
53+
5154Target Audience and Prerequisites
5255=================================
5356
@@ -75,6 +78,7 @@ Content
7578 change_proposal_process
7679 reviewer
7780 approver
81+ account_creation
7882 git_account
7983 code_editors
8084 rst
0 commit comments