process: overview of project organization

Issue-ref: resolves #21
eclipse-score · Dec 4, 2024 · 23ff879 · 23ff879
1 parent 3670d55
commit 23ff879
Show file tree

Hide file tree

Showing 11 changed files with 460 additions and 0 deletions.
diff --git a/.vscode/extensions.json b/.vscode/extensions.json
@@ -0,0 +1,6 @@
+{
+    "recommendations": [
+        "useblocks.sphinx-needs-vscode",
+        "swyddfa.esbonio"
+    ]
+}
diff --git a/.vscode/restructuredtext.code-snippets b/.vscode/restructuredtext.code-snippets
@@ -0,0 +1,77 @@
+{
+    "stkh_req_directive": {
+    "prefix": "stkh_req_t",
+    "body": [
+        ".. sthk_req:: $1",
+        "   :id: STHK_REQ__$RANDOM_HEX${RANDOM_HEX/([a-zA-z0-9}]{2,2})(.*)/$1/} $2",
+        "   :reqtype: ${3|Functional, Interface, Process, Legal, Non-Functional|}",
+        "   :security: ${4|YES,NO|}",
+        "   :safety: ${5|QM, ASIL_B, ASIL_D|}",
+        "   :rationale: $6",
+        "   :status: ${7|valid,invalid|}\n",
+        "   $8" ],
+    "description": "Generate an stakeholder directive need with all needed option types",
+    },
+    "feat_req_directive":
+    { "prefix": "feat_req_t",
+        "body": [ ".. feat_req:: $1",
+        "   :id: FEAT_REQ__$RANDOM_HEX${RANDOM_HEX/([a-zA-z0-9}]{2,2})(.*)/$1/} $2",
+        "   :reqtype: ${3|Functional, Interface, Process, Legal, Non-Functional|}",
+        "   :security: ${4|YES,NO|}",
+        "   :safety: ${5|QM, ASIL_B, ASIL_D|}",
+        "   :satisfies: STHK_REQ__$6",
+        "   :status: ${7|valid,invalid|}\n",
+        "   $8" ],
+        "description": "Generate an feature directive need with all needed option types",
+    },
+    "comp_req_directive": { "prefix": "comp_req_t",
+        "body": [ ".. comp_req:: $1",
+        "   :id: COMP_REQ__$RANDOM_HEX${RANDOM_HEX/([a-zA-z0-9}]{2,2})(.*)/$1/} $2",
+        "   :reqtype: ${3|Functional, Interface, Process, Legal, Non-Functional|}",
+        "   :security: ${4|YES,NO|}",
+        "   :safety: ${5|QM, ASIL_B, ASIL_D|}",
+        "   :satisfies: FEAT_REQ__$6",
+        "   :status: ${7|valid,invalid|}\n",
+            "   $8" ],
+        "description": "Generate an component requirement directive need with all needed option types",
+    },
+    "tool_req_directive": { "prefix": "tool_req_t",
+    "body": [ ".. tool_req:: $1",
+        "   :id: TOOL_REQ__$RANDOM_HEX${RANDOM_HEX/([a-zA-z0-9}]{2,2})(.*)/$1/} $2",
+        "   :reqtype: ${3|Functional, Interface, Process, Legal, Non-Functional|}",
+        "   :security: ${4|YES,NO|}",
+        "   :safety: ${5|QM, ASIL_B, ASIL_D|}",
+        "   :satisfies: GD__$6",
+        "   :status: ${7|valid,invalid|}\n",
+        "   $8" ],
+        "description": "Generate an tool requirement directive need with all needed option types",
+    },
+    "aou_directive": { "prefix": "aou_t",
+    "body": [ ".. aou:: $1",
+        "   :id: AOU_REQ__$RANDOM_HEX${RANDOM_HEX/([a-zA-z0-9}]{2,2})(.*)/$1/} $2",
+        "   :reqtype: ${3|Functional, Interface, Process, Legal, Non-Functional|}",
+        "   :security: ${4|YES,NO|}",
+        "   :safety: ${5|ASIL_B, ASIL_D|}",
+        "   :satisfies: $6",
+        "   :status: ${7|valid,invalid|}\n",
+        "   $8" ],
+        "description": "Generate an AoU directive need with all needed option types",
+    },
+    "feat_arc_directive":
+    { "prefix": "feat_arc_t",
+        "body": [ ".. feat_arc::",
+            "   :id: $1",
+            "   :satisfies: $2",
+            "   :status: $3\n",
+            "   $4" ],
+        "description": "Generate an feature directive need with all needed option types",
+    },
+    "comp_arc_directive": { "prefix": "comp_arc_t",
+        "body": [ ".. comp_arc::",
+            "   :id: $1",
+            "   :satisfies: $2",
+            "   :status: $3\n",
+            "   $4" ],
+        "description": "Generate an component directive need with all needed option types",
+    },
+}
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -0,0 +1,46 @@
+{
+    // General Settings
+    "files.insertFinalNewline": true,
+    "files.trimTrailingWhitespace": true,
+    "editor.insertSpaces": true,
+    "editor.tabCompletion": "on",
+    "editor.wordWrap": "wordWrapColumn",
+    "editor.wrappingIndent": "same",
+    "editor.wordWrapColumn": 100,
+    "editor.rulers": [
+        100
+    ],
+
+    // RST Settings
+    "[restructuredtext]": {
+       "editor.tabSize": 3,
+    },
+
+    // Sphinx Needs Extension
+    "sphinx-needs.folders": [
+        {
+            "needsJson": "${workspaceFolder}/bazel-bin/docs/docs/_build/html/needs.json",
+            "srcDir": "${workspaceFolder}/docs",
+        },
+        {
+            "needsJson": "${workspaceFolder}/bazel-bin/docs/docs/_build/html/needs.json",
+            "srcDir": "${workspaceFolder}/process/process_model",
+        },
+    ],
+
+    // Esbonio 0.x (Current)
+    // see https://github.com/swyddfa/esbonio/blob/0.x/docs/lsp/getting-started.rst
+    // and https://github.com/swyddfa/esbonio/blob/0.x/docs/lsp/editors/vscode/_configuration.rst
+    "esbonio.server.pythonPath": "${workspaceFolder}/.venv_docs/bin/python",
+    "esbonio.sphinx.confDir": "${workspaceFolder}",
+    "esbonio.sphinx.buildDir": "${workspaceFolder}/_build",
+    "esbonio.server.logLevel": "info",
+    // Do not auto-install. We'll use the one in the venv.
+    "esbonio.server.installBehavior": "nothing",
+
+    // Esbonio 1.x (Preview)
+    "esbonio.sphinx.pythonCommand": [".venv_docs/bin/python"],
+    "esbonio.sphinx.buildCommand": ["-b", "html", ".", "_build", "--jobs", "auto"],
+    // default is "error", which doesn't show anything.
+    "esbonio.logging.level": "warning"
+}
diff --git a/docs/conf.py b/docs/conf.py
@@ -45,6 +45,7 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
 html_theme = "alabaster"
+html_theme_options = {"page_width": "auto", "body_max_width": "1500"}
 
 # -- sphinx-needs configuration --------------------------------------------
 

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

diff --git a/docs/index.rst b/docs/index.rst
@@ -23,3 +23,4 @@ Documentation
    tool_requirements/index.rst
    process_description/index.rst
    features/index.rst
+   platform_management_plan/index.rst
diff --git a/docs/platform_management_plan/_assets/project_organization.svg b/docs/platform_management_plan/_assets/project_organization.svg
diff --git a/docs/platform_management_plan/index.rst b/docs/platform_management_plan/index.rst
@@ -0,0 +1,44 @@
+..
+   # *******************************************************************************
+   # 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
+   # *******************************************************************************
+
+Platform Management Plan
+========================
+
++---------------------------+-------------------------------+
+| DOCUMENT IDENTIFICATION   |                               |
++===========================+===============================+
+| Document Type             | Plan                          |
++---------------------------+-------------------------------+
+| Document ID               | PLATFORM-MANAGEMENT-PLAN      |
++---------------------------+-------------------------------+
+| Project Name              | <Name>                        |
++---------------------------+-------------------------------+
+| ASIL                      | B                             |
++---------------------------+-------------------------------+
+| Security Classification   | CONFIDENTIAL                  |
++---------------------------+-------------------------------+
+| AUTHOR                    | <Process Manager>             |
++---------------------------+-------------------------------+
+| Reviewer                  | <Quality Manager>             |
++---------------------------+-------------------------------+
+| Approver                  | <Project Manager>             |
++---------------------------+-------------------------------+
+| Status                    | [DRAFT, VERIFIED, RELEASED]   |
++---------------------------+-------------------------------+
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Content
+
+   project_management