Skip to content

Commit a662157

Browse files
authored
Add attribute requirement to config mgmt (#690)
When using "needs extend" attributes of needs elements can be overwritten. As a result the created html can differ from the source rst. This shall be prohibited and only allowed to add tags which help to generate e.g. reports. Signed-off-by: Philipp Ahmann <philipp.ahmann@de.bosch.com>
1 parent 0db77d1 commit a662157

1 file changed

Lines changed: 22 additions & 0 deletions

File tree

process/process_areas/configuration_management/guidance/configuration_process_req.rst

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,3 +61,25 @@ Configuration Management Process Requirements
6161
It shall be possible to show the differences between two baselines.
6262

6363
Note: This could be done by showing all the commits which happened between these baselines in one release branch.
64+
65+
.. gd_req:: Document attributes
66+
:id: gd_req__config_consistent_attributes
67+
:status: valid
68+
:tags: prio_2_automation
69+
:complies: std_req__aspice_40__SUP-8-BP3, std_req__aspice_40__SUP-8-BP4
70+
:satisfies: wf__platform_cr_mt_platform_mgmt_plan
71+
72+
It shall be prohibited to override any mandatory attribute value of an docs-as-code element.
73+
74+
Note: This requirement exists because docs-as-code attributes may be globally overridden, which leads to a mismatch of code and the representing generated documentation.
75+
Exception only exists for optional tags, which can be used for filtering and reporting purposes.
76+
77+
.. gd_req:: Global tags extension
78+
:id: gd_req__config_global_tags
79+
:status: valid
80+
:tags: prio_3_automation
81+
:satisfies: wf__platform_cr_mt_platform_mgmt_plan
82+
83+
It shall be possible to define global tags with the docs-as-code tool, which can be used for filtering and reporting.
84+
85+
Note: This requirement exists to enable the use of global tags for filtering and reporting purposes, while still prohibiting the overriding of mandatory attributes or elements globally.

0 commit comments

Comments
 (0)