Merge pull request #143 from MaximilianSoerenPollak/MSP_prep_dac_1.0

masc2023 · web-flow · commit d7fe6052ee16 · 2025-07-30T11:28:43.000+02:00
Upgrade to Docs-As-Code 1.0
diff --git a/.bazelversion b/.bazelversion
@@ -1 +1 @@
-7.4.0
+8.3.0
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -38,5 +38,5 @@ jobs:
       id-token: write
 
     with:
-      bazel-target: "//process:incremental_latest"
+      bazel-target: "//:docs -- --github_user=${{ github.repository_owner }} --github_repo=${{ github.event.repository.name }}"
       retention-days: 3
diff --git a/BUILD b/BUILD
@@ -25,6 +25,7 @@ load("@score_cr_checker//:cr_checker.bzl", "copyright_checker")
 # SPDX-License-Identifier: Apache-2.0
 # *******************************************************************************
 load("@score_format_checker//:macros.bzl", "use_format_targets")
+load("@score_docs_as_code//:docs.bzl", "docs")
 
 package(default_visibility = ["//visibility:public"])
 
@@ -47,3 +48,7 @@ copyright_checker(
     template = "@score_cr_checker//resources:templates",
     visibility = ["//visibility:public"],
 )
+
+docs (
+    source_dir="process"
+)
diff --git a/MODULE.bazel b/MODULE.bazel
@@ -13,7 +13,7 @@
 
 module(
     name = "score_process",
-    version = "1.0.4",
+    version = "1.0.5",
     compatibility_level = 1,
 )
 
@@ -53,9 +53,9 @@ bazel_dep(name = "buildifier_prebuilt", version = "8.2.0.2")
 bazel_dep(name = "aspect_rules_lint", version = "1.4.4")
 
 # Provides, pytest & venv
-bazel_dep(name = "score_python_basics", version = "0.3.2")
+bazel_dep(name = "score_python_basics", version = "0.3.4")
 
 # Checker rule for CopyRight checks/fixes
 bazel_dep(name = "score_cr_checker", version = "0.2.2")
 bazel_dep(name = "score_format_checker", version = "0.1.1")
-bazel_dep(name = "score_docs_as_code", version = "0.4.4")
+bazel_dep(name = "score_docs_as_code", version = "1.0.0-RC1")
diff --git a/README.md b/README.md
@@ -19,21 +19,18 @@ The process model provide processes, which conform to state-of the art standards
 
 #### Run a documentation build:
 
-#### Integrate latest score main branch
-
 ```bash
-bazel run //process:incremental_latest
-bazel build //process:docs_latest
+bazel run //:docs
 ```
 
 #### Access your documentation at:
 
 - `_build/` for incremental
-- `bazel-bin/bazel-bin/<BUILD FILE FOLDER NAME>/docs/_build/html`
+- `bazel-bin/bazel-bin/docs/_build/html`
 
 #### Getting IDE support
 
-Create the virtual environment via `bazel run //process:ide_support`.\
+Create the virtual environment via `bazel run //:ide_support`.\
 If your IDE does not automatically ask you to activate the newly created environment you can activate it.
 
 - In VSCode via `ctrl+p` => `Select Python Interpreter` then select `.venv_docs/bin/python` OR
@@ -43,8 +40,7 @@ If your IDE does not automatically ask you to activate the newly created environ
 Now run the live_preview commands
 
 ```bash
-bazel run //process:incremental_latest
-bazel run //process:live_preview_latest
+bazel run //:live_preview
 ```
 
 #### Format your documentation with:
diff --git a/process/BUILD b/process/BUILD
diff --git a/process/conf.py b/process/conf.py
@@ -21,6 +21,8 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
 project = "Process Description"
+project_url = "https://eclipse-score.github.io/process_description/"
+project_prefix = "PROCESS_"
 author = "S-CORE"
 version = "0.1"
 
diff --git a/process/standards/aspice_40/aspice.rst b/process/standards/aspice_40/aspice.rst
@@ -418,13 +418,13 @@ Generic practices
 
       For guidance on how to perform process improvements see the Process Improvement process (PIM.3).
 
-.. needextend:: docname is not None and "process/standards/aspice" in docname
-   :+tags: aspice
+.. needextend:: "c.this_doc()" 
+   :+tags: aspice40_gp3
 
 Appendix
 --------
 
 .. needtable:: General Practices
    :style: datatables
    :columns: id;title;status;content
-   :filter: id.startswith("std_req__aspice_40__gp") and is_external == False
+   :filter: c.this_doc()
diff --git a/process/standards/aspice_40/iic/iic-01.rst b/process/standards/aspice_40/iic/iic-01.rst
@@ -1,4 +1,4 @@
-..
+..
    # *******************************************************************************
    # Copyright (c) 2025 Contributors to the Eclipse Foundation
    #
@@ -49,3 +49,5 @@
    - The name of work products and an associated reference (to file, to tool artifact)
    - Configuration item attributes and properties
 
+.. needextend:: "c.this_doc()" 
+   :+tags: aspice40_iic01
diff --git a/process/standards/aspice_40/iic/iic-02.rst b/process/standards/aspice_40/iic/iic-02.rst
@@ -29,3 +29,7 @@
        - budget
        - equipment
        - facilities
+
+
+.. needextend:: "c.this_doc()" 
+   :+tags: aspice40_iic02
diff --git a/process/standards/aspice_40/iic/iic-03.rst b/process/standards/aspice_40/iic/iic-03.rst
@@ -59,3 +59,5 @@
       - reviews such as optical inspections à findings record
       - analyses: values
 
+.. needextend:: "c.this_doc()" 
+   :+tags: aspice40_iic03
diff --git a/process/standards/aspice_40/iic/iic-04.rst b/process/standards/aspice_40/iic/iic-04.rst
@@ -76,3 +76,6 @@
      - semi-formal languages (e.g, UML, SysML)
      - formal languages (e.g, model-based approach)
 
+
+.. needextend:: "c.this_doc()" 
+   :+tags: aspice40_iic04
diff --git a/process/standards/aspice_40/iic/iic-06.rst b/process/standards/aspice_40/iic/iic-06.rst
@@ -58,3 +58,7 @@
 
    - Description / confirmation of existing backup and recovery mechanisms
    - References to corresponding procedures or regulations
+
+
+.. needextend:: "c.this_doc()" 
+   :+tags: aspice40_iic06
diff --git a/process/standards/aspice_40/iic/iic-07.rst b/process/standards/aspice_40/iic/iic-07.rst
@@ -161,4 +161,7 @@
    - Relation to process measurement metrics
    - Storage and retrieval
    - Effective controls over access
-
+
+
+.. needextend:: "c.this_doc()" 
+   :+tags: aspice40_iic07
diff --git a/process/standards/aspice_40/iic/iic-08.rst b/process/standards/aspice_40/iic/iic-08.rst
@@ -156,3 +156,6 @@
      or common causes of variation
    - Effective implementation of these counter measures
 
+
+.. needextend:: "c.this_doc()" 
+   :+tags: aspice40_iic08
diff --git a/process/standards/aspice_40/iic/iic-10.rst b/process/standards/aspice_40/iic/iic-10.rst
@@ -64,3 +64,6 @@
    - Required services
    - Required samples
 
+
+.. needextend:: "c.this_doc()" 
+   :+tags: aspice40_iic10
diff --git a/process/standards/aspice_40/iic/iic-11.rst b/process/standards/aspice_40/iic/iic-11.rst
@@ -70,3 +70,7 @@
    - a representation of a software unit under verification such as
      commented source code, auto-code, an object file, a library, an
      executable, or an executable model as input to verification
+
+
+.. needextend:: "c.this_doc()" 
+   :+tags: aspice40_iic11
diff --git a/process/standards/aspice_40/iic/iic-12.rst b/process/standards/aspice_40/iic/iic-12.rst
@@ -30,3 +30,5 @@
    - Identifies the person who will be qualifying the reuse candidate
 
 
+.. needextend:: "c.this_doc()" 
+   :+tags: aspice40_iic12
diff --git a/process/standards/aspice_40/iic/iic-13.rst b/process/standards/aspice_40/iic/iic-13.rst
@@ -234,3 +234,5 @@
    - for non-standard and critical resources and infrastructure.
 
 
+.. needextend:: "c.this_doc()" 
+   :+tags: aspice40_iic13
diff --git a/process/standards/aspice_40/iic/iic-14.rst b/process/standards/aspice_40/iic/iic-14.rst
@@ -92,3 +92,5 @@
      amount of the complete set of all software parts of the software
 
 
+.. needextend:: "c.this_doc()" 
+   :+tags: aspice40_iic14
diff --git a/process/standards/aspice_40/iic/iic-15.rst b/process/standards/aspice_40/iic/iic-15.rst
@@ -197,3 +197,5 @@
          within established quantitative control limits
 
 
+.. needextend:: "c.this_doc()" 
+   :+tags: aspice40_iic15
diff --git a/process/standards/aspice_40/iic/iic-16.rst b/process/standards/aspice_40/iic/iic-16.rst
@@ -58,3 +58,5 @@
    - Organizational units and sub-units, if applicable
 
 
+.. needextend:: "c.this_doc()" 
+   :+tags: aspice40_iic16
diff --git a/process/standards/aspice_40/iic/iic-17.rst b/process/standards/aspice_40/iic/iic-17.rst
@@ -114,3 +114,5 @@
     Needs are derived from Work Breakdown structure and schedule
 
 
+.. needextend:: "c.this_doc()" 
+   :+tags: aspice40_iic17
diff --git a/process/standards/aspice_40/iic/iic-18.rst b/process/standards/aspice_40/iic/iic-18.rst
@@ -150,3 +150,5 @@
    - Conditions, constraints, assumptions
 
 
+.. needextend:: "c.this_doc()" 
+   :+tags: aspice40_iic18
diff --git a/process/standards/aspice_40/iic/iic-19.rst b/process/standards/aspice_40/iic/iic-19.rst
@@ -31,3 +31,5 @@
        - options due to socio-cultural differences
 
 
+.. needextend:: "c.this_doc()" 
+   :+tags: aspice40_iic19
diff --git a/process/standards/aspice_40/index.rst b/process/standards/aspice_40/index.rst
@@ -18,5 +18,3 @@
 
    aspice
 
-.. needextend:: docname is not None and "process/standards/aspice_40" in docname
-   :+tags: aspice_40
diff --git a/process/standards/aspice_40/man/man.3.rst b/process/standards/aspice_40/man/man.3.rst
@@ -156,3 +156,5 @@ Base practices
       Refer to SUP.9 for resolution of problems
 
 
+.. needextend:: "c.this_doc()" 
+   :+tags: aspice40_man3
diff --git a/process/standards/aspice_40/man/man.5.rst b/process/standards/aspice_40/man/man.5.rst
@@ -104,3 +104,5 @@ Base practices
       Corrective actions may involve reevaluation of risks, developing and implementing new mitigation concepts or adjusting the existing concepts.
 
 
+.. needextend:: "c.this_doc()" 
+   :+tags: aspice40_man5
diff --git a/process/standards/aspice_40/pim/pim.3.rst b/process/standards/aspice_40/pim/pim.3.rst
@@ -130,3 +130,5 @@ Identify issues from the analysis of process performance and derive improvement
    Knowledge gained from the improvements and progress of the improvement implementation is communicated to affected parties.
 
 
+.. needextend:: "c.this_doc()"  
+   :+tags: aspice40_pim3
diff --git a/process/standards/aspice_40/reu/reu.2.rst b/process/standards/aspice_40/reu/reu.2.rst
@@ -104,4 +104,5 @@ Base practices
 
 
 
-
+.. needextend:: "c.this_doc()"  
+   :+tags: aspice40_reu2
diff --git a/process/standards/aspice_40/spl/spl.2.rst b/process/standards/aspice_40/spl/spl.2.rst
@@ -113,4 +113,5 @@ Base practices
 
 
 
-
+.. needextend:: "c.this_doc()"     
+   :+tags: aspice40_spl2
diff --git a/process/standards/aspice_40/sup/sup.1.rst b/process/standards/aspice_40/sup/sup.1.rst
@@ -116,3 +116,5 @@ Base practices
       The decision whether to escalate non-conformances may be based on criteria such as delay of resolution, urgency, and risk.
 
 
+.. needextend:: "c.this_doc()" 
+   :+tags: aspice40_sup1
diff --git a/process/standards/aspice_40/sup/sup.10.rst b/process/standards/aspice_40/sup/sup.10.rst
@@ -109,3 +109,5 @@ Base practices
          Examples for informing affected parties can be daily standup meetings or tool-supported workflows.
 
 
+.. needextend:: "c.this_doc()" 
+   :+tags: aspice40_sup10
diff --git a/process/standards/aspice_40/sup/sup.8.rst b/process/standards/aspice_40/sup/sup.8.rst
@@ -145,3 +145,5 @@ Base practices
       This may include references to corresponding procedures or regulations.
 
 
+.. needextend:: "c.this_doc()"
+   :+tags: aspice40_sup8
diff --git a/process/standards/aspice_40/sup/sup.9.rst b/process/standards/aspice_40/sup/sup.9.rst
@@ -112,3 +112,5 @@ Base practices
       how and when they were found, what their impacts were, etc.
 
 
+.. needextend:: "c.this_doc()" 
+   :+tags: aspice40_sup9
diff --git a/process/standards/aspice_40/swe/swe.1.rst b/process/standards/aspice_40/swe/swe.1.rst
@@ -158,5 +158,6 @@ Base practices
    Communicate the agreed software requirements, and the results of the analysis
    of impact on the operating environment, to all affected parties.
 
-.. needextend:: docname is not None and "process/standards/aspice" in docname
-   :+tags: aspice
+
+.. needextend:: "c.this_doc()" 
+   :+tags: aspice40_swe1
diff --git a/process/standards/aspice_40/swe/swe.2.rst b/process/standards/aspice_40/swe/swe.2.rst
@@ -137,3 +137,5 @@ Base practices
    architecture to all affected parties.
 
 
+.. needextend:: "c.this_doc()"  
+   :+tags: aspice40_swe2
diff --git a/process/standards/aspice_40/swe/swe.3.rst b/process/standards/aspice_40/swe/swe.3.rst
@@ -150,3 +150,5 @@ Base practices
    affected parties.
 
 
+.. needextend:: "c.this_doc()" 
+   :+tags: aspice40_swe3
diff --git a/process/standards/aspice_40/swe/swe.4.rst b/process/standards/aspice_40/swe/swe.4.rst
@@ -114,3 +114,5 @@ Base practices
       parties to judge the consequences.
 
 
+.. needextend:: "c.this_doc()" 
+   :+tags: aspice40_swe4
diff --git a/process/standards/aspice_40/swe/swe.5.rst b/process/standards/aspice_40/swe/swe.5.rst
@@ -189,3 +189,5 @@ Base practices
       other parties to judge the consequences.
 
 
+.. needextend:: "c.this_doc()" 
+   :+tags: aspice40_swe5
diff --git a/process/standards/aspice_40/swe/swe.6.rst b/process/standards/aspice_40/swe/swe.6.rst
@@ -125,3 +125,5 @@ Base practices
       parties to judge the consequences.
 
 
+.. needextend:: "c.this_doc()"     
+   :+tags: aspice40_swe6
diff --git a/process/standards/index.rst b/process/standards/index.rst
