diff --git a/process/conf.py b/process/conf.py index 8ca547f795..bdbe54315b 100644 --- a/process/conf.py +++ b/process/conf.py @@ -40,15 +40,18 @@ # into the Sphinx HTML output root so portals are served alongside the docs. html_extra_path = ["trainings/_portals"] +# exclude pattern are not supported when calling sphinx-build from other repositories, +# so we do not use them here. Instead, the exclusion of training source files +# and generated portal files is handled in the Sphinx build hook below. # Exclude training source files and generated portal files from Sphinx processing. # - trainings/*/source/** : Markdown source files for the training portals # - trainings/trainings_templates/** : Template files, not Sphinx documents # - trainings/_portals/** : Generated portal HTML (served via html_extra_path) -exclude_patterns = [ - "trainings/*/source/**", - "trainings/trainings_templates/**", - "trainings/_portals/**", -] +#exclude_patterns = [ +# "trainings/*/source/**", +# "trainings/trainings_templates/**", +# "trainings/_portals/**", +#] # :need:`{title}` is used in the needs templates to display the title of the need needs_role_need_template = "{title}" diff --git a/process/trainings/trainings_requirements_engineering/source/content/index.md b/process/trainings/trainings_requirements_engineering/source/content/index.md index 876ff7acc2..be2236d127 100644 --- a/process/trainings/trainings_requirements_engineering/source/content/index.md +++ b/process/trainings/trainings_requirements_engineering/source/content/index.md @@ -26,6 +26,8 @@ prev: null next: url: module-1.html label: "Module 1: Why Requirements Engineering?" +orphan: true +suppress_warnings: ["myst.xref_missing"] --- ```{caution} @@ -55,12 +57,12 @@ security-critical automotive open-source software development. | Module | Title | Description | Duration | |--------|-------|-------------|----------| -| Module 1 | [Why Requirements Engineering?](module-1.html) | Role of RE in safety-critical OSS, stakeholders, roles, and how standards drive the process. | ~30 min | -| Module 2 | [Requirement Levels and Types](module-2.html) | The five requirement levels (Stakeholder, Feature, Component, AoU, Process), types, and their traceability relationships. | ~45 min | -| Module 3 | [Requirement Attributes and Quality](module-3.html) | Mandatory and auto-generated attributes, formulation rules, versioning, and reviews. | ~45 min | -| Module 4 | [Workflows and Work Products](module-4.html) | The six S-CORE workflows, work products with compliance tags, and end-to-end traceability. | ~45 min | +| Module 1 | Why Requirements Engineering? | Role of RE in safety-critical OSS, stakeholders, roles, and how standards drive the process. | ~30 min | +| Module 2 | Requirement Levels and Types | The five requirement levels (Stakeholder, Feature, Component, AoU, Process), types, and their traceability relationships. | ~45 min | +| Module 3 | Requirement Attributes and Quality | Mandatory and auto-generated attributes, formulation rules, versioning, and reviews. | ~45 min | +| Module 4 | Workflows and Work Products | The six S-CORE workflows, work products with compliance tags, and end-to-end traceability. | ~45 min | -**[Checkpoint Quiz — All Modules](quiz-1.html)** +**Checkpoint Quiz — All Modules** 10 questions covering all four modules. Pass mark: 70%. Instant scoring with explanations. (~20 min) ## About This Course diff --git a/process/trainings/trainings_requirements_engineering/source/content/module-1.md b/process/trainings/trainings_requirements_engineering/source/content/module-1.md index 828688ab6c..6443af3996 100644 --- a/process/trainings/trainings_requirements_engineering/source/content/module-1.md +++ b/process/trainings/trainings_requirements_engineering/source/content/module-1.md @@ -32,6 +32,7 @@ prev: next: url: module-2.html label: "Module 2: Requirement Levels and Types" +orphan: true --- # Why Requirements Engineering? diff --git a/process/trainings/trainings_requirements_engineering/source/content/module-2.md b/process/trainings/trainings_requirements_engineering/source/content/module-2.md index c596a7ef1e..751ab11463 100644 --- a/process/trainings/trainings_requirements_engineering/source/content/module-2.md +++ b/process/trainings/trainings_requirements_engineering/source/content/module-2.md @@ -32,6 +32,7 @@ prev: next: url: module-3.html label: "Module 3: Requirement Attributes and Quality" +orphan: true --- # Requirement Levels and Types diff --git a/process/trainings/trainings_requirements_engineering/source/content/module-3.md b/process/trainings/trainings_requirements_engineering/source/content/module-3.md index 9bf5a98070..c00143b48a 100644 --- a/process/trainings/trainings_requirements_engineering/source/content/module-3.md +++ b/process/trainings/trainings_requirements_engineering/source/content/module-3.md @@ -32,6 +32,7 @@ prev: next: url: module-4.html label: "Module 4: Workflows and Work Products" +orphan: true --- # Requirement Attributes and Quality diff --git a/process/trainings/trainings_requirements_engineering/source/content/module-4.md b/process/trainings/trainings_requirements_engineering/source/content/module-4.md index 4964694b04..a27b258240 100644 --- a/process/trainings/trainings_requirements_engineering/source/content/module-4.md +++ b/process/trainings/trainings_requirements_engineering/source/content/module-4.md @@ -32,6 +32,7 @@ prev: next: url: quiz-1.html label: "Checkpoint Quiz" +orphan: true --- # Workflows and Work Products diff --git a/process/trainings/trainings_requirements_engineering/source/content/quiz-1.md b/process/trainings/trainings_requirements_engineering/source/content/quiz-1.md index b0aeff3fb1..46932103af 100644 --- a/process/trainings/trainings_requirements_engineering/source/content/quiz-1.md +++ b/process/trainings/trainings_requirements_engineering/source/content/quiz-1.md @@ -170,5 +170,5 @@ questions: behaviour. Each level links to its parent using a versioned 'derived_from' reference. Process Requirements are a separate, parallel concern derived from the process description, not a step that precedes stakeholder requirements. - +orphan: true --- diff --git a/process/trainings/trainings_templates/content/index.md b/process/trainings/trainings_templates/content/index.md index 66aa0b3d1b..23cac613e5 100644 --- a/process/trainings/trainings_templates/content/index.md +++ b/process/trainings/trainings_templates/content/index.md @@ -26,6 +26,8 @@ prev: null next: url: module-1.html label: "Module 1: [First Module Title]" +orphan: true +suppress_warnings: ["myst.xref_missing"] --- # [PROCESS AREA] — Training Overview @@ -45,12 +47,12 @@ and work products. | Module | Title | Description | Duration | |--------|-------|-------------|----------| -| Module 1 | [[Module 1 Title]](module-1.html) | [Short description] | ~XX min | -| Module 2 | [[Module 2 Title]](module-2.html) | [Short description] | ~XX min | -| Module 3 | [[Module 3 Title]](module-3.html) | [Short description] | ~XX min | -| Module 4 | [[Module 4 Title]](module-4.html) | [Short description] | ~XX min | +| Module 1 | [Module 1 Title] | [Short description] | ~XX min | +| Module 2 | [Module 2 Title] | [Short description] | ~XX min | +| Module 3 | [Module 3 Title] | [Short description] | ~XX min | +| Module 4 | [Module 4 Title] | [Short description] | ~XX min | -**[[Quiz Title]](quiz-1.html)** +**[Quiz Title]** [N] questions covering all modules. Pass mark: 70%. Instant scoring with explanations. (~20 min) ## About This Course diff --git a/process/trainings/trainings_templates/content/module-N.md b/process/trainings/trainings_templates/content/module-N.md index a5b105705a..ddcb18b11b 100644 --- a/process/trainings/trainings_templates/content/module-N.md +++ b/process/trainings/trainings_templates/content/module-N.md @@ -32,6 +32,7 @@ prev: next: url: module-2.html # or quiz-1.html for last module label: "Module 2: [Next Title]" # or "[Quiz Title]" +orphan: true --- # [Module Title] diff --git a/process/trainings/trainings_templates/content/quiz-N.md b/process/trainings/trainings_templates/content/quiz-N.md index 34c2546f8d..3e8bfc7a0a 100644 --- a/process/trainings/trainings_templates/content/quiz-N.md +++ b/process/trainings/trainings_templates/content/quiz-N.md @@ -149,3 +149,5 @@ questions: - text: "[Distractor 3]" feedback: >- Correct: B. [Explanation.] +orphan: true +---