Skip to content

Commit 8be8399

Browse files
authored
adapt account creation doc (#27)
adapt account creation doc This PR is created on base of #26 to reimplement it on top of current master branch ignoring all not relevant local commits: git checkout -b Nils-Magnus-toplevel_struct main git pull [email protected]:Nils-Magnus/docs_on_docs.git toplevel_struct git cherry-pick a1eb128 git checkout -b toplevel_struct git push Reviewed-by: Nils Magnus <[email protected]> Reviewed-by: Tino Schr Reviewed-by: SebastianGode
1 parent 348291d commit 8be8399

File tree

4 files changed

+58
-33
lines changed

4 files changed

+58
-33
lines changed

doc/source/account creation

Lines changed: 0 additions & 16 deletions
This file was deleted.

doc/source/account_creation.rst

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
=================
2+
GitHub Onboarding
3+
=================
4+
5+
Most of our documentation is hosted on GitHub, a service based on, but
6+
not the same as Git. To work with GitHub, an account is needed.
7+
8+
9+
How to join GitHub
10+
------------------
11+
12+
1. Go to https://github.com/ .
13+
14+
2. On the top right corner is a button with "sign up".
15+
16+
3. Enter your corporate email address and press "continue".
17+
18+
4. Create a strong password.
19+
20+
5. Enter a username e.g. johndoe
21+
22+
6. Would you like to receive updates? I suggest opting out with
23+
entering "n".
24+
25+
7. Verify your account by solving the task to prove you aren't a bot.
26+
27+
8. Click on the "create an account" button.
28+
29+
9. You are almost done! GitHub just sent you a launch you that has to
30+
be entered to create the account ultimately. Note: The code has to
31+
be entered manually and you can't enter it via copy & paste.
32+
33+
10. You are asked with how many people you are working with and if you
34+
are a student or a teacher. This personalization can be skipped at
35+
the bottom of the Website. I suggest skipping this step.
36+
37+
11. Congratulations! You just created your GitHub account!

doc/source/index.rst

Lines changed: 18 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,31 +2,33 @@
22
Documentation 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

89
Working in the Open
910
===================
1011

1112
The 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

2224
Responsibilities and Ownership
2325
==============================
2426

2527
The content of the projects is owned by the Open Telekom Cloud Squads
2628
responsible 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

3133
All assets in the repository are public visible, and so are the PRs or
3234
the 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
4850
Owner Community and during the XXXXXXXXXXX meeting/call/board. It was
4951
approved on November XX, 2021 as authoritative by the board.
5052

53+
5154
Target 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

tox.ini

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ whitelist_externals = cp
4141
deps =
4242
-r{toxinidir}/doc/requirements.txt
4343
commands =
44-
sphinx-build -W --keep-going -b revealjs doc/source/ doc/build/reveal
44+
# sphinx-build -W --keep-going -b revealjs doc/source/ doc/build/reveal
4545
sphinx-build -W --keep-going -b html doc/source/ doc/build/html
46-
cp -av doc/build/reveal/_static/revealjs4 doc/build/html/_static
47-
cp -av doc/build/reveal/presentations doc/build/html/
46+
# cp -av doc/build/reveal/_static/revealjs4 doc/build/html/_static
47+
# cp -av doc/build/reveal/presentations doc/build/html/

0 commit comments

Comments
 (0)