From b8ec865ac8464edd4bb201d725b82be46f5e50c8 Mon Sep 17 00:00:00 2001
From: Lukasz Tekieli <lukasz.tekieli@bmw.de>
Date: Thu, 28 Nov 2024 14:06:00 +0100
Subject: [PATCH] docs: add config-as-code docs

Issue-ref: resolves #14
---
 docs/features/integration/config_as_code.rst | 68 ++++++++++++++++++++
 docs/features/integration/index.rst          |  9 +++
 2 files changed, 77 insertions(+)
 create mode 100644 docs/features/integration/config_as_code.rst

diff --git a/docs/features/integration/config_as_code.rst b/docs/features/integration/config_as_code.rst
new file mode 100644
index 0000000..508aa04
--- /dev/null
+++ b/docs/features/integration/config_as_code.rst
@@ -0,0 +1,68 @@
+..
+   # *******************************************************************************
+   # Copyright (c) 2024 Contributors to the Eclipse Foundation
+   #
+   # See the NOTICE file(s) distributed with this work for additional
+   # information regarding copyright ownership.
+   #
+   # This program and the accompanying materials are made available under the
+   # terms of the Apache License Version 2.0 which is available at
+   # https://www.apache.org/licenses/LICENSE-2.0
+   #
+   # SPDX-License-Identifier: Apache-2.0
+   # *******************************************************************************
+
+Configuration as code
+#####################
+
+Documentation
+*************
+
+Description
+===========
+
+Score project uses GitHub for hosting source code as well as GitHub
+Actions for all CI/CD task. The configuration of the organization and
+repositories is managed by otterdog, a config-as-code solution. GitHub
+provides several approaches to set up repositories. In order to provide
+unified experience among all the Score repositories, the following rules
+should be followed.
+
+For in depth description of the properties and the relations, please
+refer to the otterdog documentation.
+
+Current setup can be viewed in the dashboard:
+https://otterdog.eclipse.org/projects/automotive.score
+
+Automatically generated documentation for eclipse-score otterdog
+configuration is here: https://eclipse-score.github.io/.eclipsefdn/
+
+All changes to the configuration should be handled by pull requests in
+https://github.com/eclipse-score/.eclipsefdn/
+
+Organization settings
+---------------------
+
+``default_branch_name`` - the default branch name for newly created
+repositories is set to ``main``.
+
+``has_discussions`` - organisation level discussions are enabled.
+``discussion_source_repository`` - organization level discussiones are
+attached to ``eclipse-score/score`` repository.
+
+Repository settings
+-------------------
+
+``homepage`` - the link that is displayed when opening the repository in
+github. ``environments`` - ``github-pages`` environment needs to be
+defined for building documentation. ``gh_pages_build_type`` - set to
+``workflow`` to build the documentation rather than serve static
+content.
+
+References
+==========
+
+-  GitHub documentation: https://docs.github.com/en
+-  GitHub repositories: https://docs.github.com/en/repositories
+-  GitHub actions: https://docs.github.com/en/actions
+-  otterdog: https://otterdog.readthedocs.io/en/latest/
diff --git a/docs/features/integration/index.rst b/docs/features/integration/index.rst
index f4ea9aa..2cc24a7 100644
--- a/docs/features/integration/index.rst
+++ b/docs/features/integration/index.rst
@@ -65,4 +65,13 @@ References
 -  Bazel modules: https://bazel.build/external/module
 -  Bazel registries: https://bazel.build/external/registry
 
+Subfeatures
+***********
+
+.. toctree::
+  :titlesonly:
+  :maxdepth: 1
+
+  config_as_code.rst
+
 .. |score_high_level_dependencies| image:: _assets/score_high_level_dependencies.png