-
Notifications
You must be signed in to change notification settings - Fork 4
adapt account creation doc #27
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.
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
Changes from 1 commit
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
This file was deleted.
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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! | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. ... and fixing the right one with proper formatting. |
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -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. | ||
|
|
||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. reformatting |
||
|
|
||
| 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. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. reformatting |
||
|
|
||
| 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 | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. should be updated in a later PR |
||
| 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 | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. adding this file to the main page |
||
| git_account | ||
| code_editors | ||
| rst | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This PR is mainly about re-syncing a few files.