docs: Content for the start page

* Adds some cards for documentation highlights * Adds a needtable to show all needs * Adds sphinx-design as dependency Issue-ref: resolves #38
eclipse-score · Dec 9, 2024 · e3111d3 · e3111d3
1 parent ea4ea5c
commit e3111d3
Show file tree

Hide file tree

Showing 16 changed files with 100 additions and 11 deletions.
diff --git a/docs/_assets/css/score.css b/docs/_assets/css/score.css
@@ -160,6 +160,7 @@ div.score_banner {
 #videowrapper{  
     position: relative;
     overflow: hidden;
+    margin-bottom: 50px;
 } 
 
 #fullScreenDiv{
@@ -199,6 +200,7 @@ div.score_banner {
     /* font-size: 4.5em; */
     font-size: 8.0cqw;
     font-weight: 900;
+    margin-bottom: 20px;
 
     /* Is somehow cool with image/video title background */
     /*animation: fadeIn 3s;  */

diff --git a/docs/_assets/css/score_design.css b/docs/_assets/css/score_design.css
@@ -0,0 +1,14 @@
+/* ########################### */
+/* SPHINX-DESIGN configs only! */
+/* ########################### */
+
+.score-grid .sd-card-header  {
+    background-color: var(--pst-color-secondary) !important;
+    color: var(--pst-color-text-muted);
+    font-weight: 900;
+    font-size: 1.2em;
+
+}
+.score-grid .sd-card-body {
+    text-align: justify;
+}
diff --git a/docs/_assets/css/score_needs.css b/docs/_assets/css/score_needs.css
@@ -70,3 +70,8 @@ html[data-theme="dark"] {
     background-color: var(--pst-color-table-row-zebra-high-bg);
 }
 
+html[data-theme="dark"] {
+    --sn-color-need-bg-head: #20242b;
+    --sn-color-datatable-label: var(--pst-color-text-base)
+}
+
diff --git a/docs/conf.py b/docs/conf.py
@@ -32,6 +32,7 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
 extensions = [
+    "sphinx_design",
     "sphinx_needs",
 ]
 
@@ -50,6 +51,7 @@
 html_css_files = [
     "css/score.css",
     "css/score_needs.css",
+    "css/score_design.css",
 ]
 
 html_theme_options = {

diff --git a/docs/features/index.rst b/docs/features/index.rst
@@ -12,6 +12,8 @@
    # SPDX-License-Identifier: Apache-2.0
    # *******************************************************************************
 
+.. _features:
+
 Features
 ========
 

diff --git a/docs/features/infrastructure/index.rst b/docs/features/infrastructure/index.rst
@@ -12,6 +12,8 @@
    # SPDX-License-Identifier: Apache-2.0
    # *******************************************************************************
 
+.. _infrastructure_feratures:
+
 ################
  Infrastructure
 ################

diff --git a/docs/features/integration/index.rst b/docs/features/integration/index.rst
@@ -12,6 +12,8 @@
    # SPDX-License-Identifier: Apache-2.0
    # *******************************************************************************
 
+.. _integration_features:
+
 Integration
 ###########
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -23,6 +23,15 @@ Documentation
 
    </div>
 
+.. toctree::
+   :maxdepth: 2
+   :hidden:
+
+   requirements/index   
+   features/index
+   process/index
+
+
 .. raw:: html
 
    <div id="videowrapper">
@@ -35,10 +44,53 @@ Documentation
       </div>
    </div>
 
-.. toctree::
-   :maxdepth: 2
-   :glob:
+Welcome & Overview
+------------------
+
+**Welcome to the Software documentation of the SCORE project.**
+
+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.
+
+.. 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.
+
+
+
+   .. grid-item-card:: 
+
+      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:: 
+
+      Process
+      ^^^
+      Understand how we work, by reading our :ref:`Process guide <process_description>`.
+
+      Or receive tips & tricks for :ref:`Templates <stakeholder_requirements_template>` and
+      :ref:`Tools <configuration_tool_guidelines>`.
+
+Data warehouse
+--------------
+
+Beeing addicted to data and objects? Here are all our Sphinx-Needs objects for a quick deep-dive.
+
+.. needtable::
+   :columns: id, title, type, status, safety, security
 
-   requirements/index   
-   features/index
-   process/index
diff --git a/docs/process/guidelines/index.rst b/docs/process/guidelines/index.rst
@@ -12,7 +12,7 @@
    # SPDX-License-Identifier: Apache-2.0
    # *******************************************************************************
 
-.. _Configuration_Tool_Guidelines:
+.. _configuration_tool_guidelines:
 
 #############################
 Configuration/Tool Guidelines

diff --git a/docs/process/index.rst b/docs/process/index.rst
@@ -12,7 +12,7 @@
    # SPDX-License-Identifier: Apache-2.0
    # *******************************************************************************
 
-.. _Process_description:
+.. _process_description:
 
 Process
 =======

diff --git a/docs/process/templates/index.rst b/docs/process/templates/index.rst
@@ -12,7 +12,7 @@
    # SPDX-License-Identifier: Apache-2.0
    # *******************************************************************************
 
-.. _Stakeholder_Requirements_Template:
+.. _stakeholder_requirements_template:
 
 Stakeholder Requirements Template
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -3,3 +3,4 @@
 Sphinx==8.1.3
 sphinx-needs==4.1.0
 pydata-sphinx-theme==0.16.0
+sphinx-design==0.6.1
diff --git a/docs/requirements/index.rst b/docs/requirements/index.rst
@@ -12,6 +12,8 @@
    # SPDX-License-Identifier: Apache-2.0
    # *******************************************************************************
 
+.. _requirements:
+
 Requirements
 ============
 

diff --git a/docs/requirements/stakeholder/index.rst b/docs/requirements/stakeholder/index.rst
@@ -12,7 +12,7 @@
    # SPDX-License-Identifier: Apache-2.0
    # *******************************************************************************
 
-.. _Stakeholder_Requirements:
+.. _stakeholder_requirements:
 
 Stakeholder Requirements
 ========================

diff --git a/docs/requirements/tool/index.rst b/docs/requirements/tool/index.rst
@@ -12,7 +12,7 @@
    # SPDX-License-Identifier: Apache-2.0
    # *******************************************************************************
 
-.. _Tool_Requirements:
+.. _tool_requirements:
 
 Tool Requirements
 =================

diff --git a/docs/requirements_lock.txt b/docs/requirements_lock.txt
@@ -355,12 +355,17 @@ sphinx==8.1.3 \
     #   -r docs/requirements.txt
     #   pydata-sphinx-theme
     #   sphinx-data-viewer
+    #   sphinx-design
     #   sphinx-needs
     #   sphinxcontrib-jquery
 sphinx-data-viewer==0.1.5 \
     --hash=sha256:a7d5e58613562bb745380bfe61ca8b69997998167fd6fa9aea55606c9a4b17e4 \
     --hash=sha256:b74b1d304c505c464d07c7b225ed0d84ea02dcc88bc1c49cdad7c2275fbbdad4
     # via sphinx-needs
+sphinx-design==0.6.1 \
+    --hash=sha256:b11f37db1a802a183d61b159d9a202314d4d2fe29c163437001324fe2f19549c \
+    --hash=sha256:b44eea3719386d04d765c1a8257caca2b3e6f8421d7b3a5e742c0fd45f84e632
+    # via -r docs/requirements.txt
 sphinx-needs==4.1.0 \
     --hash=sha256:7d40e9c29353d9784f469b2093412846060cda4f3b55127ac58a2692c3381ef9 \
     --hash=sha256:8ae21e10515249aaba3dabd7fd66afdedd1160ecbc5816337fb6ed82aca293b7