Skip to content
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

Toplevel struct #26

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 4 additions & 0 deletions bin/webserver.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
#!/bin/sh

cd doc/build/html
python3 -m http.server 5000
16 changes: 0 additions & 16 deletions doc/source/account creation

This file was deleted.

37 changes: 37 additions & 0 deletions doc/source/account_creation.rst
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!
32 changes: 18 additions & 14 deletions doc/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
=================================

Expand Down Expand Up @@ -75,6 +78,7 @@ Content
change_proposal_process
reviewer
approver
account_creation
git_account
code_editors
rst
Expand Down
Binary file added doc/source/presentations/ansible/ansible-play.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
21 changes: 21 additions & 0 deletions doc/source/presentations/ansible/ansible-play.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
- name: Update web servers
hosts: webservers
remote_user: root

tasks:
- name: Ensure apache is at the latest version
ansible.builtin.yum:
name: httpd
state: latest
- name: Write the apache config file
ansible.builtin.template:
src: /srv/httpd.j2
dest: /etc/httpd.conf







Loading