Squashed 'docs/scs-docs/' content from commit 2d736c0

git-subtree-dir: docs/scs-docs
git-subtree-split: 2d736c0

Author: maxwolfs

Contributor-Docs/README.md

@@ -0,0 +1,38 @@
+# Community
+
+Entrypoint for getting onboarded.
+
+## Tools used by the community
+
+- Instant messaging
+  - [Matrix](https://matrix.to/#/!TiDqlLmEUaXqTemaLc:matrix.org?via=matrix.org)
+  - [Nextcloud Talk](https://scs.sovereignit.de/nextcloud) (Not used)
+  - [Fosstodon](https://fosstodon.org/@sovereigncloudstack) (Only one-directional)
+- Annoucements
+  - [Mailing-List](https://scs.sovereignit.de/mailman3/postorius/lists/announce.lists.scs.community/)
+  - [RSS Feed](https://scs.community/feed.xml)
+  - [Fosstodon](https://fosstodon.org/@sovereigncloudstack)
+  - [Twitter](https://twitter.com/scs_osballiance)
+  - [LinkedIn](https://www.linkedin.com/showcase/sovereigncloudstack)
+  - [Website](https://scs.community)
+- Video-Calls
+  - [Jitsi](https://conf.scs.koeln:8443/SCS-TECH)
+- Groupware/Fileshare/Organizational Stuff
+  - [Nextcloud](https://scs.sovereignit.de/nextcloud)
+  - [Mailing-List](https://scs.sovereignit.de/mailman3/postorius/lists/announce.lists.scs.community/)
+- Task distribution
+  - [GitHub](https://github.com/SovereignCloudStack)
+  - [Mailing-List](https://scs.sovereignit.de/mailman3/postorius/lists/announce.lists.scs.community/)
+- Guides
+  - [GitHub](https://github.com/SovereignCloudStack)
+  - [Contributor Guide](https://scs.community/docs/contributor/)
+
+### ToDo's
+
+Based on the discussion within https://github.com/SovereignCloudStack/Docs/pull/58.
+
+- [ ] establish a Community Board and discuss proposals on a montly basis
+- [ ] find a tool (Jekyll framework maybe) to deliver the Docs repo as a website
+- [ ] discuss the meaningfullness of an onboarding channel in the desired instant messaging tool
+- [ ] Having a single URL for all services?
+

Contributor-Docs/collaboration.md

@@ -0,0 +1,93 @@
+# Collaboration
+
+## Collaborating with issues and pull requests
+
+We use the GitHub flow to track and discuss changes in issues, then propose and
+review changes in pull requests. See the
+[GitHub documentation](https://docs.github.com/en/free-pro-team@latest/github/collaborating-with-issues-and-pull-requests)
+for more details.
+
+## Meetings
+
+### Project updates
+
+- Weekly with all teams on Thursday at 1505 CEST (45 mins)
+
+### Sprint review/Backlog refinement/Sprint planning meetings
+
+- Weekly with Team IaaS on Wednesdays at 1005 CEST (1 hour)
+- Weekly with Team Container on Mondays at 1005 CEST (1 hour)
+- Weekly with Team OPS & IAM on Thursdays at 1005 CEST (1 hour)
+
+### Special interest groups (SIGs)
+
+- Identity & Access Management (IAM): Bi-Weekly on Friday at 1005 CEST (1 hour)
+- Monitoring & Logging: Weekly on Friday at 1205 CEST (1 hour)
+
+## Videoconference
+
+We use a self-hosted [Jitsi Meet](https://jitsi.org) instance for video conferencing.
+
+The server uses an automated deployment based on the
+[heat-docker-jitsi-meet](https://github.com/garloff/heat-docker-jitsi-meet) project.
+
+Configuration is such everyone who knows the room can connect, unless the moderator
+sets a password/PIN. Opening a new room requires authentication. (Contact Kurt if
+you need a password.)
+
+### Usage
+
+Connect with a desktop browser (Chrome/Chromium or other blink based browser
+recommended due to superior WebRTC implementation with SimulCast/SVC for VP8/VP9 --
+Safari & Firefox work, but cause higher data traffic). For mobile devices use
+the Jitsi Meet App.
+
+Use the little arrows in the control bar at the bottom to select speaker, microphone
+and camera in case you lack audio/video. Occasionally, you can not hear all but
+one participant; in this case reconnecting typically helps.
+
+We have an asterisk connected to some conference rooms to provide dial-in capabilities
+for folks that lack internet connectivity (but have a working phone connection).
+
+## Nextcloud
+
+We have a [Nextcloud](https://nextcloud.com)
+[instance](https://scs.sovereignit.de) for sharing files, calendar, contacts, ...
+setup for things that are not public.
+
+We are also using it for our taskboards currently, though we are looking at
+options to do this in the open.
+
+If you want to contribute, we'll do an onboarding call and add you to nextcloud.
+This will also add you to the [email protected] mailing list.
+
+We have an announcements mailing list there [email protected] and you
+can subscribe via the [mailman3 frontend](https://scs.sovereignit.de/mailman3/postorius/lists/)
+
+## Zuul CI/CD pipelines and project gating
+
+Since we are expecting a lot of pipelines beeing created and used GitHub actions won't keep up
+well. We also expect cross-repository and even cross-project dependencies. Therefore we decided to
+use Zuul as our main pipeline solution.
+
+### How to make a repo use Zuul
+
+- Make Zuul aware of your repository in this repo: https://github.com/SovereignCloudStack/zuul_deployment
+- Create a file *.zuul.yaml*
+    - An example can be found here: https://github.com/SovereignCloudStack/zuul-sandbox/blob/main/.zuul.yaml
+    - You can have a job section containing *self-defined* jobs which you need to write on your own
+    - You have to have a project section containing
+        - the default-branch name
+        - the merge-mode which should be used to auto-merge
+        - the jobs to run in each pipeline (gh_check, gh_gate, gh_post, gh_tag)
+        - these pipelines are triggered by events which can be looked up here: https://github.com/SovereignCloudStack/zuul_config/blob/main/zuul.d/gh_pipelines.yaml
+        - some default jobs can be found here: https://opendev.org/zuul/zuul-jobs/src/branch/master/playbooks
+- If you have *self-defined* jobs, you need to create a folder *.playbooks*
+    - this folder containers ansible playbooks which will be triggered
+
+
+### General information about Zuul
+
+Zuul does not take anything for granted. If you need to have something installed,
+you should install it via ansible. Our test-machines are basically pimped
+docker-containers, so we might run into issues some time. But for now, things work pretty good.

Contributor-Docs/dco-and-licenses.md

@@ -0,0 +1,66 @@
+# Developer Certificate of Origin + Licenses
+
+The Developer Certificate of Origin (DCO) is a lightweight way for contributors
+to certify that they wrote or otherwise have the right to submit the code they
+are contributing to the Sovereign Cloud Stack.
+
+```
+By making a contribution to this project, I certify that:
+
+(a) The contribution was created in whole or in part by me and I
+    have the right to submit it under the open source license
+    indicated in the file; or
+
+(b) The contribution is based upon previous work that, to the best
+    of my knowledge, is covered under an appropriate open source
+    license and I have the right under that license to submit that
+    work with modifications, whether created in whole or in part
+    by me, under the same open source license (unless I am
+    permitted to submit under a different license), as indicated
+    in the file; or
+
+(c) The contribution was provided directly to me by some other
+    person who certified (a), (b) or (c) and I have not modified
+    it.
+
+(d) I understand and agree that this project and the contribution
+    are public and that a record of the contribution (including all
+    personal information I submit with it, including my sign-off) is
+    maintained indefinitely and may be redistributed consistent with
+    this project or the open source license(s) involved.
+```
+
+All contributions to the Sovereign Cloud Stack are licensed under the
+(OSI approved) open source license of the upstream project being used therein
+(very often this is the [Apache Software License v2](https://www.apache.org/licenses/LICENSE-2.0)).
+
+Where we create independent code, we prefer to use the [GNU Affero General Public License 3](https://www.gnu.org/licenses/agpl-3.0.html),
+except for interface code which we would put under LGPL-3 (weak copyleft).
+Own documentation content is licensed under [Creative Commons BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/).
+
+Contributors sign-off that they adhere to these requirements by adding a `Signed-off-by`
+line to commit messages.
+
+```
+My fancy commit message
+
+Signed-off-by: Christian Berendt <[email protected]>
+```
+
+Git has a `-s` command line option to append this automatically to your commit message:
+
+```
+git commit -s -m 'My fancy commit message'
+```
+
+The status of a pull request is set to failed if commits do not contain a valid `Signed-off-by` line.
+
+![Failed DCO in GitHub](github-failed-dco.png)
+
+Considerations behind the choice of AGPLv3, CC-BY-SA and the usage of the DCO can be found [here](license-considerations.md).
+
+## Further reading
+
+- <https://developercertificate.org/>
+- <https://julien.ponge.org/blog/developer-certificate-of-origin-versus-contributor-license-agreements/>
+- <https://lwn.net/Articles/592503/>