Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 8 additions & 5 deletions process/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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}"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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}
Expand Down Expand Up @@ -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 | <a href="module-1.html">Why Requirements Engineering?</a> | Role of RE in safety-critical OSS, stakeholders, roles, and how standards drive the process. | ~30 min |
| Module 2 | <a href="module-2.html">Requirement Levels and Types</a> | The five requirement levels (Stakeholder, Feature, Component, AoU, Process), types, and their traceability relationships. | ~45 min |
| Module 3 | <a href="module-3.html">Requirement Attributes and Quality</a> | Mandatory and auto-generated attributes, formulation rules, versioning, and reviews. | ~45 min |
| Module 4 | <a href="module-4.html">Workflows and Work Products</a> | The six S-CORE workflows, work products with compliance tags, and end-to-end traceability. | ~45 min |

**[Checkpoint Quiz — All Modules](quiz-1.html)**
**<a href="quiz-1.html">Checkpoint Quiz — All Modules</a>**
10 questions covering all four modules. Pass mark: 70%. Instant scoring with explanations. (~20 min)

## About This Course
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ prev:
next:
url: module-2.html
label: "Module 2: Requirement Levels and Types"
orphan: true
---

# Why Requirements Engineering?
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ prev:
next:
url: module-3.html
label: "Module 3: Requirement Attributes and Quality"
orphan: true
---

# Requirement Levels and Types
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ prev:
next:
url: module-4.html
label: "Module 4: Workflows and Work Products"
orphan: true
---

# Requirement Attributes and Quality
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ prev:
next:
url: quiz-1.html
label: "Checkpoint Quiz"
orphan: true
---

# Workflows and Work Products
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
---
12 changes: 7 additions & 5 deletions process/trainings/trainings_templates/content/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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 | <a href="module-1.html">[Module 1 Title]</a> | [Short description] | ~XX min |
| Module 2 | <a href="module-2.html">[Module 2 Title]</a> | [Short description] | ~XX min |
| Module 3 | <a href="module-3.html">[Module 3 Title]</a> | [Short description] | ~XX min |
| Module 4 | <a href="module-4.html">[Module 4 Title]</a> | [Short description] | ~XX min |

**[[Quiz Title]](quiz-1.html)**
**<a href="quiz-1.html">[Quiz Title]</a>**
[N] questions covering all modules. Pass mark: 70%. Instant scoring with explanations. (~20 min)

## About This Course
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
2 changes: 2 additions & 0 deletions process/trainings/trainings_templates/content/quiz-N.md
Original file line number Diff line number Diff line change
Expand Up @@ -149,3 +149,5 @@ questions:
- text: "[Distractor 3]"
feedback: >-
Correct: B. [Explanation.]
orphan: true
---
Loading