docs: restructure general guidelines

move all general guidance documents into one folder tutorial

Author: hoe-jo

docs/guidance/index.rst renamed to docs/contribute/ci/index.rst

@@ -12,11 +12,10 @@
    # SPDX-License-Identifier: Apache-2.0
    # *******************************************************************************
 
-Guidance
-========
+CI
+##
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
 
-   docs-as-code
    publishing-gh-pages

docs/guidance/publishing-gh-pages.rst renamed to docs/contribute/ci/publishing-gh-pages.rst

@@ -12,9 +12,9 @@
    # SPDX-License-Identifier: Apache-2.0
    # *******************************************************************************
 
-###############################
- Contribution Request Guideline
-###############################
+
+Contribution Request Guideline
+##############################
 
 .. gd_guidl:: Contribution Request Guideline
   :id: gd_guidl__contr_request_guideline

docs/process/guidance/contribution_request/_assets/score_contribution_request_simple.drawio.svg renamed to docs/contribute/contribution_request/_assets/score_contribution_request_simple.drawio.svg

@@ -12,18 +12,10 @@
    # SPDX-License-Identifier: Apache-2.0
    # *******************************************************************************
 
-.. _process_guidance:
-
-#########
- Guidance
-#########
+Contribution Request
+####################
 
 .. toctree::
    :maxdepth: 1
-   :glob:
 
-   git/index.rst
-   branch/index.rst
-   feature_flags/index.rst
-   general/index.rst
-   contribution_request/index.rst
+   contribution_request

docs/process/guidance/contribution_request/_assets/score_contribution_request_standard.drawio.svg renamed to docs/contribute/contribution_request/_assets/score_contribution_request_standard.drawio.svg

@@ -55,7 +55,7 @@ To activate this feature, use the following feature flag:
 
     .. note::
      The feature flag must reflect the feature name in snake_case. Further, it is prepended with ``experimental_``, as
-     long as the feature is not yet stable. See :doc:`/process/guidance/feature_flags/index` for more information.
+     long as the feature is not yet stable. See :ref:`feature_flags` for more information.
 
 
 Abstract

docs/process/guidance/contribution_request/_assets/score_discussion_request_options.drawio.svg renamed to docs/contribute/contribution_request/_assets/score_discussion_request_options.drawio.svg

@@ -14,12 +14,10 @@
 
 .. _contribution_templates:
 
-#######################
- Contribution Templates
-#######################
+Contribution Templates
+######################
 
 .. toctree::
    :maxdepth: 1
-   :glob:
 
    feature_request_template.rst

docs/process/guidance/contribution_request/index.rst renamed to docs/contribute/contribution_request/contribution_request.rst

@@ -0,0 +1,20 @@
+..
+   # *******************************************************************************
+   # 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
+   # *******************************************************************************
+
+Development
+###########
+
+.. toctree::
+   :maxdepth: 1
+

docs/process/guidance/index.rst renamed to docs/contribute/contribution_request/index.rst

@@ -12,8 +12,8 @@
    # SPDX-License-Identifier: Apache-2.0
    # *******************************************************************************
 
-Guidance: Docs-As-Code
-======================
+Docs-As-Code
+============
 
 Introduction
 ------------

docs/process/guidance/contribution_request/templates/feature_request_template.rst renamed to docs/contribute/contribution_request/templates/feature_request_template.rst

@@ -0,0 +1,21 @@
+..
+   # *******************************************************************************
+   # 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
+   # *******************************************************************************
+
+Documentation
+#############
+
+.. toctree::
+   :maxdepth: 1
+
+   docs-as-code

docs/process/guidance/contribution_request/templates/index.rst renamed to docs/contribute/contribution_request/templates/index.rst

@@ -12,6 +12,8 @@
    # SPDX-License-Identifier: Apache-2.0
    # *******************************************************************************
 
+.. _feature_flags:
+
 Feature Flags
 =============
 

docs/contribute/development/index.rst

@@ -12,51 +12,10 @@
    # SPDX-License-Identifier: Apache-2.0
    # *******************************************************************************
 
-General
-=======
-
-.. _naming_convention_files:
-
-Naming Conventions of Files
----------------------------
-
-The overall naming convention is to use snake case for all files and folders (all files are named lowercase and spaces are replaced by underscores).
-
-.. _naming_convention_needs:
-
-Naming Convention for UIDs
---------------------------
-
-The naming convention for the UIDs of **all** elements shall be defined as follows:
-
-* It should not exceed 30 characters
-* It shall show a meaningful name
-* It shall only consist of lowercase, digits and underscores
-
-For the naming of the UIDs also following convention shall be applied:
-
-* It shall consist of 3 parts separated by double underscore
-   * | prefix
-     | (defined in the Metamodel)
-   * | structural element
-     | (e.g. abbreviation for the feature / subfeature)
-   * | keyword (s)
-     | (keyword(s) referring the the description, separated by underscore)
-
-As examples:
-
-* feat_req__ipc__e2e_protection
-* comp_req__kvs__storage
-
-Only for **process UIDs** the structural element is optional:
-
-* gd_temp__review
-* gd_req__req__structure
-
 .. _Platform_Folder_Structure:
 
 Folder Structure of Platform Repository
----------------------------------------
+=======================================
 
 The following shows the folder structure of the platform repository (ordered alphabetically). The ordering of the documentation in the rendered documentation
 can be in a different order.
@@ -138,7 +97,3 @@ can be in a different order.
     registry/                                       -> infrastructure configuration
 
     README.md                                       -> Entrypoint of the repository.
-
-.. toctree::
-   :maxdepth: 1
-   :glob:

docs/guidance/assets/docs-as-code/drawio-editing.png renamed to docs/contribute/documentation/assets/docs-as-code/drawio-editing.png

@@ -0,0 +1,24 @@
+..
+   # *******************************************************************************
+   # 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
+   # *******************************************************************************
+
+General
+#######
+
+.. toctree::
+   :maxdepth: 1
+
+   naming
+   git
+   folder
+   feature_flags

docs/guidance/assets/docs-as-code/example.drawio.svg renamed to docs/contribute/documentation/assets/docs-as-code/example.drawio.svg

@@ -0,0 +1,75 @@
+..
+   # *******************************************************************************
+   # 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
+   # *******************************************************************************
+
+Naming Conventions
+==================
+
+.. _naming_convention_files:
+
+Naming Conventions of Files
+---------------------------
+
+The overall naming convention is to use snake case for all files and folders (all files are named lowercase and spaces are replaced by underscores).
+
+.. _naming_convention_needs:
+
+Naming Convention for UIDs
+--------------------------
+
+The naming convention for the UIDs of **all** elements shall be defined as follows:
+
+* It should not exceed 30 characters
+* It shall show a meaningful name
+* It shall only consist of lowercase, digits and underscores
+
+For the naming of the UIDs also following convention shall be applied:
+
+* It shall consist of 3 parts separated by double underscore
+   * | prefix
+     | (defined in the Metamodel)
+   * | structural element
+     | (e.g. abbreviation for the feature / subfeature)
+   * | keyword (s)
+     | (keyword(s) referring the the description, separated by underscore)
+
+As examples:
+
+* feat_req__ipc__e2e_protection
+* comp_req__kvs__storage
+
+Only for **process UIDs** the structural element is optional:
+
+* gd_temp__review
+* gd_req__req__structure
+
+.. _branch_naming:
+
+Naming convention for git branches
+----------------------------------
+
+In order to keep an overview which branch belongs to whom the branch
+name also should be descriptive. The following rules shall apply:
+
+#. The branch name shall start with your github username. This will make
+   it easier for everybody to identify the owner of the branch.
+#. Branch names must be lower case.
+#. Concatenation is done by underscores _.
+
+An example could look like this:
+
+Mustermann, GitHub Name: maximuster
+
+.. code::
+
+   maximuster_my_awesome_branch_name

docs/guidance/assets/docs-as-code/example.puml renamed to docs/contribute/documentation/assets/docs-as-code/example.puml

@@ -12,28 +12,17 @@
    # SPDX-License-Identifier: Apache-2.0
    # *******************************************************************************
 
-##########
- Branches
-##########
-
-.. _branch_naming:
-
-*******************
- Naming Convention
-*******************
+.. _contribute:
 
-In order to keep an overview which branch belongs to whom the branch
-name also should be descriptive. The following rules shall apply:
-
-#. The branch name shall start with your github username. This will make
-   it easier for everybody to identify the owner of the branch.
-#. Branch names must be lower case.
-#. Concatenation is done by underscores _.
-
-An example could look like this:
+Contribute
+##########
 
-Mustermann, GitHub Name: maximuster
+.. toctree::
+   :maxdepth: 2
 
-.. code::
+   general/index
+   contribution_request/index
+   documentation/index
+   development/index
+   ci/index
 
-   maximuster_my_awesome_branch_name

docs/guidance/docs-as-code.rst renamed to docs/contribute/documentation/docs-as-code.rst

@@ -118,7 +118,7 @@ Project structure and processes
       ^^^
       Understand how we work, by reading our :ref:`Process description <process_description>`.
       And receive tips & tricks for our used tool stack by reading the
-      :ref:`Guidance <process_guidance>`.
+      :ref:`contribute`.
 
    .. grid-item-card::
 
@@ -131,11 +131,11 @@ Project structure and processes
 .. dropdown:: Click to see the complete sitemap
 
    .. toctree::
-      :maxdepth: 3
+      :maxdepth: 1
 
       requirements/index
       features/index
-      guidance/index
+      contribute/index
       Releases <score_releases/index.rst>
       process/index
       PMP <platform_management_plan/index.rst>