docs: New entries for nav header and main page

* Adds management plan and release to navbar with shorter title * Adds management pland and release to the main page as card * Updates .gitignore to ignore Python, Vale and direnv configs Issue-ref: see #38
eclipse-score · Dec 18, 2024 · 4c36f87 · 4c36f87
1 parent b698cb9
commit 4c36f87
Show file tree

Hide file tree

Showing 8 changed files with 54 additions and 16 deletions.
diff --git a/.gitignore b/.gitignore
@@ -4,3 +4,13 @@ MODULE.bazel.lock
 
 # Ruff
 .ruff_cache
+
+# Python
+.venv
+
+# Vale - editorial style guide
+.vale.ini
+styles/
+
+# direnv - folder-specific bash configuration
+.envrc
diff --git a/docs/conf.py b/docs/conf.py
@@ -55,14 +55,7 @@
 
 html_theme_options = {
     "navbar_align": "content",
-    "header_links_before_dropdown": 3,
-    "external_links": [
-        {"name": "SCORE", "url": "https://eclipse-score.github.io"},
-        {
-            "name": "Eclipse",
-            "url": "https://projects.eclipse.org/projects/automotive.score",
-        },
-    ],
+    "header_links_before_dropdown": 5,
     "icon_links": [
         {
             "name": "GitHub",

diff --git a/docs/index.rst b/docs/index.rst
@@ -29,9 +29,12 @@ Documentation
 
    requirements/index
    features/index
+   Releases <score_releases/index.rst>
    process/index
-   platform_management_plan/index.rst
-   score_releases/index.rst
+   PMP <platform_management_plan/index.rst>
+   SCORE <https://eclipse-score.github.io>
+   Eclipse <https://projects.eclipse.org/projects/automotive.score>
+
 
 
 .. raw:: html
@@ -54,17 +57,18 @@ Welcome & Overview
 If this is the first time you get in touch with SCORE, the `SCORE main page <https://eclipse-score.github.io/>`__
 may be a good starting point to receive first insights of the project itself.
 
+Software artifacts
+~~~~~~~~~~~~~~~~~~
+
 .. grid:: 1 1 3 3
    :class-container: score-grid
 
    .. grid-item-card::
 
       Requirements
       ^^^
-
       Analyse :ref:`Stakeholder <stakeholder_requirements>` or :ref:`Tool <tool_requirements>` requirements for
       the work with and implementation inside SCORE.
-
       Or get the complete picture on the :ref:`requirements` page.
 
 
@@ -74,16 +78,39 @@ may be a good starting point to receive first insights of the project itself.
       Features
       ^^^
       :ref:`Features <features>` are the heart of the SCORE software.
-
       Understand the internal details of :ref:`Infrastructure <infrastructure_feratures>`
       or :ref:`Integration <integration_features>` Features.
 
+   .. grid-item-card::
+
+      Releases
+      ^^^
+      Our release roadmap can be found under :ref:`releases`.
+      Including an overview about integrated software modules and their repository location.
+
+
+Project structure and processes
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. grid:: 1 1 2 2
+   :class-container: score-grid
 
    .. grid-item-card::
 
       Process
       ^^^
       Understand how we work, by reading our :ref:`Process guide <process_description>`.
-
-      Or receive tips & tricks for :ref:`Templates <stakeholder_requirements_template>` and
+      And receive tips & tricks for our used tool stack by reading the pages :ref:`Templates <stakeholder_requirements_template>` and
       :ref:`Tools <configuration_tool_guidelines>`.
+
+   .. grid-item-card::
+
+      Platform Management Plan (PMP)
+      ^^^
+      Read about our project setup and organization structure in the
+      :ref:`pmp`.
+      And learn how we deal with :ref:`safety_management` or care about :ref:`sw_verification`.
+
+
+
+
diff --git a/docs/platform_management_plan/index.rst b/docs/platform_management_plan/index.rst
@@ -12,6 +12,8 @@
    # SPDX-License-Identifier: Apache-2.0
    # *******************************************************************************
 
+.. _pmp:
+
 Platform Management Plan
 ========================
 

diff --git a/docs/platform_management_plan/project_management.rst b/docs/platform_management_plan/project_management.rst
@@ -141,7 +141,7 @@ Platform consists of multiple repositories. The main repository, *SCORE*,
 is the integration repository, where everything comes together. It contains:
 
 * :ref:`stakeholder requirements <Stakeholder_Requirements>`
-* documentation of all :ref:`platform features <Platform_Features>` and features flags,
+* documentation of all :ref:`platform features <features>` and features flags,
   feature requirements and architecture
 * build system including *SCORE* specific *macros* and *rules*
 * integration rules for software modules.

diff --git a/docs/platform_management_plan/safety_management.rst b/docs/platform_management_plan/safety_management.rst
@@ -12,6 +12,8 @@
    # SPDX-License-Identifier: Apache-2.0
    # *******************************************************************************
 
+.. _safety_management:
+
 Safety management
 ------------------------
 

diff --git a/docs/platform_management_plan/software_verification.rst b/docs/platform_management_plan/software_verification.rst
@@ -12,6 +12,8 @@
    # SPDX-License-Identifier: Apache-2.0
    # *******************************************************************************
 
+.. _sw_verification:
+
 Software Verification
 ------------------------
 

diff --git a/docs/score_releases/index.rst b/docs/score_releases/index.rst
@@ -12,6 +12,8 @@
    # SPDX-License-Identifier: Apache-2.0
    # *******************************************************************************
 
+.. _releases:
+
 SCORE Releases Overview
 =======================