diff --git a/doc/source/account creation b/doc/source/account creation deleted file mode 100644 index 2a217d8..0000000 --- a/doc/source/account creation +++ /dev/null @@ -1,16 +0,0 @@ -================================ -GitHub Documentation Inboarding -================================ -How to join GitHub ---------------------- -1. Got to https://github.com/ -2. On the top right corner is a button with “sign up” -3. Enter your corporate Email and press continue -4. Create strong and memorable password -5. Enter a username e.g. joedoe -6. Would you like to receive updates? I suggest opting out with entering “n” -7. Verify your account by solving the task to prove you aren´t a bot -8. Hit a “create an account” -9. You are almost done! GitHub just sent you a launch you that has to be entered to create the account ultimately. Note: The Code has to be entered manually and can´t be entered via “copy & paste” -10. You are asked with how many people you are working with and if you are a student or a teacher. This personalization can be skipped at the bottom of the Website. I would suggest skipping this step. -11. Congratulations you just created you GitHub account diff --git a/doc/source/account_creation.rst b/doc/source/account_creation.rst new file mode 100644 index 0000000..204bd91 --- /dev/null +++ b/doc/source/account_creation.rst @@ -0,0 +1,37 @@ +================= +GitHub Onboarding +================= + +Most of our documentation is hosted on GitHub, a service based on, but +not the same as Git. To work with GitHub, an account is needed. + + +How to join GitHub +------------------ + +1. Go to https://github.com/ . + +2. On the top right corner is a button with "sign up". + +3. Enter your corporate email address and press "continue". + +4. Create a strong password. + +5. Enter a username e.g. johndoe + +6. Would you like to receive updates? I suggest opting out with + entering "n". + +7. Verify your account by solving the task to prove you aren't a bot. + +8. Click on the "create an account" button. + +9. You are almost done! GitHub just sent you a launch you that has to + be entered to create the account ultimately. Note: The code has to + be entered manually and you can't enter it via copy & paste. + +10. You are asked with how many people you are working with and if you + are a student or a teacher. This personalization can be skipped at + the bottom of the Website. I suggest skipping this step. + +11. Congratulations! You just created your GitHub account! diff --git a/doc/source/index.rst b/doc/source/index.rst index b253871..d420439 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -2,31 +2,33 @@ Documentation about documentation ================================= -This repository will contain information that anybody -maintaining Open Telekom Cloud documentation need to know. +This repository contains information that maintainers of the Open +Telekom Cloud documentation need to know. + Working in the Open =================== The Open Telekom Cloud values transparency as a main principle. -Therefore, all public facing documentation is maintained in the -open, by open-source components. All steps of the process are -publicly visible and transparent. This eases the collaboration -of our suppliers, OTC staff, and even customers or users. All -can propose changes, all can participate in the review process, -and each team can appoint arbitrary persons to approve changes, -ensuring the integrity of the overall documentation. All changes -are recorded and archived, so changes can be rolled back, and -audit trails are available even for the tiniest change. +Therefore, all public facing documentation is maintained in the open, +by open-source components. All steps of the process are publicly +visible and transparent. This eases the collaboration of our +suppliers, OTC staff, and even customers or users. All can propose +changes, all can participate in the review process, and each team can +appoint arbitrary persons to approve changes, ensuring the integrity +of the overall documentation. All changes are recorded and archived, +so changes can be rolled back, and audit trails are available even for +the tiniest change. + Responsibilities and Ownership ============================== The content of the projects is owned by the Open Telekom Cloud Squads responsible for the services respectively. Each team can appoint one -or several Squad members (or external contributors, if -suitable). Typically, one documentation lead and a deputy are -recommended, but other setups are also possible. +or several Squad members (or external contributors, if suitable). +Typically, one documentation lead and a deputy are recommended, but +other setups are also possible. All assets in the repository are public visible, and so are the PRs or 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 Owner Community and during the XXXXXXXXXXX meeting/call/board. It was approved on November XX, 2021 as authoritative by the board. + Target Audience and Prerequisites ================================= @@ -75,6 +78,7 @@ Content change_proposal_process reviewer approver + account_creation git_account code_editors rst diff --git a/tox.ini b/tox.ini index d6fa7d3..4457c26 100644 --- a/tox.ini +++ b/tox.ini @@ -41,7 +41,7 @@ whitelist_externals = cp deps = -r{toxinidir}/doc/requirements.txt commands = - sphinx-build -W --keep-going -b revealjs doc/source/ doc/build/reveal + # sphinx-build -W --keep-going -b revealjs doc/source/ doc/build/reveal sphinx-build -W --keep-going -b html doc/source/ doc/build/html - cp -av doc/build/reveal/_static/revealjs4 doc/build/html/_static - cp -av doc/build/reveal/presentations doc/build/html/ + # cp -av doc/build/reveal/_static/revealjs4 doc/build/html/_static + # cp -av doc/build/reveal/presentations doc/build/html/