Skip to content

Commit 0533152

Browse files
committed
resolves warnings
add SCORE_ for the links to the SCORE Project Management Plan add is_external == False or docname is not None to filter out needs from score repo add SCORE_ for references, which can not be solved in process_description
1 parent bcaf2cb commit 0533152

File tree

56 files changed

+97
-94
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

56 files changed

+97
-94
lines changed

process/general_concepts/score_review_concept.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ In this project there are inspections on the following work products, which are
6060
* - :need:`wp__sw_implementation`
6161
- :need:`gd_chklst__impl_inspection_checklist`
6262

63-
Note that for testcases on unit, component and feature level (as defined in :need:`doc__verification_plan`)
63+
Note that for testcases on unit, component and feature level (as defined in :need:`SCORE_doc__verification_plan`)
6464
also a review checklist is provided for guidance, but no formal inspection is required. The same is true for Safety Analysis and DFA.
6565
The independence of testing respectively of test case review is covered by the use of GitHub also for the review of test cases.
6666
Which means that at least the test case definition or the test case review is performed by
@@ -83,7 +83,7 @@ based on the CODEOWNER(s) definition of the modified files. In case the fixing o
8383
between reviewer(s) and author, the safety manager or quality manager can be added to the review to moderate a solution.
8484

8585
The initial step for requirements and architecture is the (informal) GitHub review on every Pull-Request
86-
(resp. Change Request, see :need:`doc__contr_guideline`)
86+
(resp. Change Request, see :need:`SCORE_doc__contr_guideline`)
8787
which creates or modifies one of these work products (subject to inspection).
8888
After this review the work products are in status "valid", which means they can be used for further development and verification steps.
8989
In this review the checklist entries shall be considered which are tagged as "incremental".

process/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ How To Contribute
9090

9191
How to contribute to the S-CORE project (e.g. naming convention, folder structure, IDE setup) can be found here:
9292

93-
:ref:`contribute`
93+
:ref:`SCORE_contribute`
9494

9595
Standards
9696
---------

process/introduction/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ Approach
4242
3. We aim to develop the process in conformance to the targeted standards (compare figure below).
4343
4. We aim to establish traceability from the begin (compare figure below, :ref:`wp_traceability_model`).
4444
5. We aim to verify conformity and traceability by tool automation as much as possible (compare figure below).
45-
6. We aim for an iterative collaboration model initiated by change requests (compare :need:`doc__contr_guideline`)
45+
6. We aim for an iterative collaboration model initiated by change requests (compare :need:`SCORE_doc__contr_guideline`)
4646

4747

4848
.. figure:: _assets/score_process_model.drawio.svg

process/process_areas/architecture_design/guidance/architecture_guideline.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Attributes
3333
For all architectural need elements following mandatory attributes are defined:
3434

3535
.. needtable:: Overview of mandatory attributes
36-
:filter: "mandatory" in tags and "attribute" in tags and "architecture_design" in tags and type == "gd_req"
36+
:filter: "mandatory" in tags and "attribute" in tags and "architecture_design" in tags and type == "gd_req" and is_external == False
3737
:style: table
3838
:columns: title; id
3939
:colwidths: 30,70
@@ -45,7 +45,7 @@ Checks
4545
For architectural elements following checks are defined:
4646

4747
.. needtable:: Overview of checks on architectural elements
48-
:filter: "check" in tags and "attribute" in tags and "architecture_design" in tags and type == "gd_req"
48+
:filter: "check" in tags and "attribute" in tags and "architecture_design" in tags and type == "gd_req" and is_external == False
4949
:style: table
5050
:columns: title; id
5151
:colwidths: 30,70
@@ -106,8 +106,8 @@ Based on this template the feature architecture shall describe the concept of th
106106

107107
For this step following guidances are available:
108108

109-
* :ref:`Branch Naming Conventions <branch_naming>`
110-
* :ref:`Git Guidelines <git_guidelines>`
109+
* :ref:`Branch Naming Conventions <SCORE_branch_naming>`
110+
* :ref:`Git Guidelines <SCORE_git_guidelines>`
111111
* :need:`[[title]] Feature Architecture <gd_temp__arch__feature>`
112112

113113
.. _model_feature_architecture:
@@ -178,8 +178,8 @@ Based on the *feature architecture* the concept for the *component architecture*
178178

179179
For this step following guidances are available:
180180

181-
* :ref:`Branch Naming Conventions <branch_naming>`
182-
* :ref:`Git Guidelines <git_guidelines>`
181+
* :ref:`Branch Naming Conventions <SCORE_branch_naming>`
182+
* :ref:`Git Guidelines <SCORE_git_guidelines>`
183183
* :need:`[[title]] <gd_temp__arch__comp>`
184184

185185
.. _allocate_component_requirements:

process/process_areas/architecture_design/guidance/architecture_process_reqs.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ Attributes of Architectural Elements
105105
* last part of the feature tree
106106
* keyword describing the content of the requirement.
107107

108-
The naming convention is defined here: :ref:`naming_convention_needs`
108+
The naming convention is defined here: :ref:`SCORE_naming_convention_needs`
109109

110110
.. gd_req:: Architecture attribute: security
111111
:id: gd_req__arch_attr_security
@@ -179,7 +179,7 @@ Checks for Architectural Design
179179
It shall be checked if all mandatory attributes for each architectural element is provided by the user. For all elements following attributes shall be mandatory:
180180

181181
.. needtable:: Overview mandatory requirement attributes
182-
:filter: "mandatory" in tags and "attribute" in tags and "architecture_design" in tags and type == "gd_req"
182+
:filter: "mandatory" in tags and "attribute" in tags and "architecture_design" in tags and type == "gd_req" and is_external == False
183183
:style: table
184184
:columns: title
185185
:colwidths: 30

process/process_areas/architecture_design/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,5 +30,5 @@ Architecture Design
3030
_assets/architecture_modeling_example
3131

3232

33-
.. needextend:: "process_areas/architecture_design" in docname
33+
.. needextend:: docname is not None and "process_areas/architecture_design" in docname
3434
:+tags: architecture_design

process/process_areas/change_management/change_management_concept.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ including the requirements of the different stakeholders for the Change Manageme
2626

2727
Key concept
2828
***********
29-
A Change Request is the **ONLY** way to contribute (compare :need:`doc__contr_guideline`)
29+
A Change Request is the **ONLY** way to contribute (compare :need:`SCORE_doc__contr_guideline`)
3030
new features or to modify the scope of existing features in the **S-CORE** project.
3131
As features are built-up by Components a Change Request is also needed to add new Components or
3232
to modify the scope of existing Components.

process/process_areas/change_management/change_management_getstrt.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,4 +25,4 @@ In case you want to contribute a change to **S-CORE** consider to:
2525
* Contact the :need:`Technical Lead <rl__technical_lead>` for your contribution to establish planning and reporting
2626
* Create your change requests according to :need:`wf__change__cr_an_change_request`
2727
* Make familiar with the development and supporting process descriptions in :ref:`process_description`
28-
* Make familiar with the relevant sections of the :ref:`Platform Management Plan <pmp>`, here especially with :need:`Change Management Plan <doc__platform_change_management_plan>`
28+
* Make familiar with the relevant sections of the :need:`Platform Management Plan <SCORE_doc__platform_mgt_plan>`, here especially with :need:`Change Management Plan <SCORE_doc__platform_change_management_plan>`

process/process_areas/change_management/change_management_workproducts.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,5 +62,5 @@ Work Products Change Management
6262
| which changes the scope of the component.
6363
| Software Modules are also Components (top-level component).
6464
65-
.. needextend:: "docs/process/change_management" in docname
65+
.. needextend:: docname is not None and "process_areas/change_management" in docname
6666
:+tags: change_management

process/process_areas/change_management/guidance/change_management_guideline.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ This document describes the general guidances for Change Management based on the
2525
General Hints
2626
=============
2727

28-
The detailed implementation of the Change Management for **S-CORE** is described in the :need:`[[title]]<doc__platform_change_management_plan>`.
28+
The detailed implementation of the Change Management for **S-CORE** is described in the :need:`[[title]]<SCORE_doc__platform_change_management_plan>`.
2929

3030
Templates
3131
---------
@@ -55,7 +55,7 @@ For all Change Requests following mandatory attributes need to be defined:
5555

5656
.. needtable:: Overview of mandatory change request attributes
5757
:tags: change_management
58-
:filter: "mandatory" in tags and "attribute" in tags and "chm" in tags
58+
:filter: "mandatory" in tags and "attribute" in tags and "chm" in tags and is_external == False
5959
:style: table
6060
:columns: title
6161
:colwidths: 30
@@ -80,7 +80,7 @@ Split may required, if
8080
8181
| 2. Affected work products are in different locations.
8282
83-
Refer to the :need:`Change Management Plan <doc__platform_change_management_plan>` for examples
83+
Refer to the :need:`Change Management Plan <SCORE_doc__platform_change_management_plan>` for examples
8484
how to create simple or more complex Change Requests.
8585

8686
.. list-table:: Activities for Change Request

0 commit comments

Comments
 (0)