Skip to content

Commit f69ffab

Browse files
docs: add folder_templates - make buildable
Ref: closes #1106
1 parent 7f924bf commit f69ffab

File tree

6 files changed

+23
-17
lines changed

6 files changed

+23
-17
lines changed

process/folder_templates/features/feature_name/architecture/index.rst

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -106,8 +106,8 @@ The following modules are needed to be defined to be able to draw the static fea
106106
They will be replaced by linking the proper module definitions in the used module's repositories as soon as those exist.
107107

108108
.. mod_view_sta:: Module Name
109-
:id: mod_view_sta__feature_name_module_name
110-
:includes: comp_arc_sta__feature_name_component_name
109+
:id: mod_view_sta__feature_name__module_name
110+
:includes: comp_arc_sta__feature_name__component_name
111111

112112
.. needarch::
113113
:scale: 50
@@ -122,7 +122,7 @@ The following components are needed to be defined to be able to draw the static
122122
They will be replaced by linking the proper SW component definitions in the used module's repositories as soon as those exist.
123123

124124
.. comp_arc_sta:: Component Name
125-
:id: comp_arc_sta__feature_name_component_name
125+
:id: comp_arc_sta__feature_name__component_name
126126
:safety: ASIL_D
127127
:security: YES
128128
:status: invalid
@@ -138,6 +138,3 @@ They will be replaced by linking the proper SW component definitions in the used
138138

139139
- Replace the example content by the real content (according to :need:`gd_guidl__arch__design`)
140140
- Set the status to valid and start the review/merge process
141-
142-
.. needextend:: "feature_name/architecture" in docname
143-
:+tags: feature_name

process/folder_templates/features/feature_name/requirements/index.rst

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,24 @@ Requirements
1818
<Headlines (for the list of requirements if structuring is needed)>
1919
===================================================================
2020

21+
.. stkh_req:: Template
22+
:id: stkh_req__requirements__template
23+
:reqtype: Non-Functional
24+
:safety: ASIL_D
25+
:rationale: Exists just for the template example
26+
:status: invalid
27+
28+
The platform shall ...
29+
30+
.. attention::
31+
The above stakeholder requirement must be removed, it just serves as a link target for this template.
32+
2133
.. feat_req:: Some Title
2234
:id: feat_req__feature_name__some_title
2335
:reqtype: Process
2436
:security: YES
2537
:safety: ASIL_D
26-
:satisfies: stkh_req__requirements__as_code
38+
:satisfies: stkh_req__requirements__template
2739
:status: invalid
2840

2941
The Feature shall do xyz to the user to bring him to this condition at this time
@@ -46,5 +58,5 @@ Requirements
4658
- Set the status to valid and start the review/merge process
4759
- Add other needed requirements for your feature
4860

49-
.. needextend:: "feature_name/requirements" in docname
61+
.. needextend:: "feature_name" in id
5062
:+tags: feature_name

process/folder_templates/modules/module_name/component_name/docs/architecture/index.rst

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ The components are designed to cover the expectations from the feature architect
6060
:status: invalid
6161
:implements: logic_arc_int__feature_name__interface_name
6262
:fulfils: comp_req__component_name__some_title
63-
:includes: comp_arc_sta__component_name_2
63+
:includes: comp_arc_sta__component_name__2
6464

6565
.. needarch::
6666
:scale: 50
@@ -97,7 +97,7 @@ Lower Level Components
9797
----------------------
9898

9999
.. comp_arc_sta:: Component Name 2
100-
:id: comp_arc_sta__component_name_2
100+
:id: comp_arc_sta__component_name__2
101101
:status: invalid
102102
:safety: ASIL_D
103103
:security: YES
@@ -113,6 +113,3 @@ Lower Level Components
113113

114114
- Replace the example content by the real content (according to :need:`gd_guidl__arch__design`)
115115
- Set the status to valid and start the review/merge process
116-
117-
.. needextend:: "module_name/component_name/docs/architecture" in docname
118-
:+tags: component_name

process/folder_templates/modules/module_name/component_name/docs/requirements/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,5 +53,5 @@ Requirements
5353
- Set the status to valid and start the review/merge process
5454
- Add other needed requirements for your feature
5555

56-
.. needextend:: "module_name/component_name/docs/requirements" in docname
56+
.. needextend:: "component_name" in id
5757
:+tags: component_name

process/folder_templates/modules/module_name/docs/safety_mgt/module_safety_plan.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -122,8 +122,8 @@ Module Workproducts List
122122
- <WP status (manual)>
123123

124124
* - :need:`wp__module_sw_build_config`
125-
- :need:`doc__software_development_plan`
126-
- :ndf:`copy('status', need_id='doc__software_development_plan')`
125+
- :need:`SCORE_doc__software_development_plan`
126+
- :ndf:`copy('status', need_id='SCORE_doc__software_development_plan')`
127127
- <Link to issue>
128128
- <Link to WP>
129129
- <automated>

process/folder_templates/modules/module_name/docs/verification/module_verification_report.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Verification Report
3333
- Adjust ``safety`` and ``tags`` according to your needs
3434

3535

36-
This verification report is based on the :need:`doc__verification_plan`.
36+
This verification report is based on the :need:`SCORE_doc__verification_plan`.
3737
It covers all the components of the above stated module.
3838

3939
Verification Report contains:

0 commit comments

Comments
 (0)