Skip to content

Conversation

@masc2023
Copy link
Contributor

@masc2023 masc2023 commented May 16, 2025

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

@masc2023 masc2023 force-pushed the masc2023_fix_refs2score branch 6 times, most recently from 6c858ae to 7ca7200 Compare May 16, 2025 12:21
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
@masc2023 masc2023 force-pushed the masc2023_fix_refs2score branch from 7ca7200 to 0533152 Compare May 16, 2025 14:16
@masc2023 masc2023 changed the title add SCORE_ for the links to the SCORE Project Management Plan resolves warnings building documentation May 16, 2025
@masc2023
Copy link
Contributor Author

masc2023 commented May 16, 2025

build //process:docs still generates the warnings below:

:ref: to score, which does not work, must be replaced by :need: in score or deleted

process/index.rst:93: WARNING: undefined label: 'score_contribute' [ref.ref]
process/process_areas/architecture_design/guidance/architecture_guideline.rst:109: WARNING: undefined label: 'score_branch_naming' [ref.ref]
process/process_areas/architecture_design/guidance/architecture_guideline.rst:110: WARNING: undefined label: 'score_git_guidelines' [ref.ref]
process/process_areas/architecture_design/guidance/architecture_guideline.rst:181: WARNING: undefined label: 'score_branch_naming' [ref.ref]
process/process_areas/architecture_design/guidance/architecture_guideline.rst:182: WARNING: undefined label: 'score_git_guidelines' [ref.ref]
process/process_areas/architecture_design/guidance/architecture_process_reqs.rst:108: WARNING: undefined label: 'score_naming_convention_needs' [ref.ref]
process/process_areas/requirements_engineering/guidance/requirements_guideline.rst:72: WARNING: undefined label: 'score_naming_convention_needs' [ref.ref]
process/process_areas/requirements_engineering/guidance/requirements_guideline.rst:136: WARNING: undefined label: 'score_branch_naming' [ref.ref]
process/process_areas/requirements_engineering/guidance/requirements_guideline.rst:137: WARNING: undefined label: 'score_git_guidelines' [ref.ref]
process/process_areas/requirements_engineering/guidance/requirements_guideline.rst:162: WARNING: undefined label: 'score_branch_naming' [ref.ref]
process/process_areas/requirements_engineering/guidance/requirements_guideline.rst:163: WARNING: undefined label: 'score_git_guidelines' [ref.ref]
process/process_areas/requirements_engineering/guidance/requirements_process_reqs.rst:55: WARNING: undefined label: 'score_naming_convention_needs' [ref.ref]
process/process_areas/requirements_engineering/requirements_getstrt.rst:74: WARNING: undefined label: 'score_setting_up_dev_env' [ref.ref]

issues with checks in metamodel from doc-as-code, needs to be resolved there

process_areas/implementation/_assets/detailed_design_example.rst:28: WARNING: dd_sta__dd_example_static.id (dd_sta__dd_example_static): expected to consisting of this format: <Req Type>__<Abbreviations>__<Architectural Element>. [score_metamodel]
process_areas/implementation/_assets/detailed_design_example.rst:42: WARNING: dd_dyn__dd_example_dynamic.id (dd_dyn__dd_example_dynamic): expected to consisting of this format: <Req Type>__<Abbreviations>__<Architectural Element>. [score_metamodel]
process_areas/implementation/_assets/detailed_design_example.rst:59: WARNING: sw_unit__unit1.id (sw_unit__unit1): expected to consisting of this format: <Req Type>__<Abbreviations>__<Architectural Element>. [score_metamodel]
process_areas/implementation/_assets/detailed_design_example.rst:70: WARNING: sw_unit_int__unit1_int1.id (sw_unit_int__unit1_int1): expected to consisting of this format: <Req Type>__<Abbreviations>__<Architectural Element>. [score_metamodel]
process_areas/implementation/_assets/detailed_design_example.rst:81: WARNING: sw_unit__unit2.id (sw_unit__unit2): expected to consisting of this format: <Req Type>__<Abbreviations>__<Architectural Element>. [score_metamodel]
process_areas/implementation/_assets/detailed_design_example.rst:92: WARNING: sw_unit_int__unit2_int2.id (sw_unit_int__unit2_int2): expected to consisting of this format: <Req Type>__<Abbreviations>__<Architectural Element>. [score_metamodel]
general_concepts/score_review_concept.rst:20: WARNING: doc_concept__wp_inspections.id (doc_concept__wp_inspections): expected to consisting of this format: <Req Type>__<Abbreviations>__<Architectural Element>. [score_metamodel]
process_areas/architecture_design/_assets/architecture_modeling_example.rst:25: WARNING: feat_arc_sta__archdes_static.id (feat_arc_sta__archdes_static): expected to consisting of this format: <Req Type>__<Abbreviations>__<Architectural Element>. [score_metamodel]
process_areas/architecture_design/_assets/architecture_modeling_example.rst:41: WARNING: logic_arc_int__archdes_logical_interface_2.id (logic_arc_int__archdes_logical_interface_2): expected to consisting of this format: <Req Type>__<Abbreviations>__<Architectural Element>. [score_metamodel]
process_areas/architecture_design/_assets/architecture_modeling_example.rst:55: WARNING: logic_arc_int__archdes_logical_interface_3.id (logic_arc_int__archdes_logical_interface_3): expected to consisting of this format: <Req Type>__<Abbreviations>__<Architectural Element>. [score_metamodel]
process_areas/architecture_design/_assets/architecture_modeling_example.rst:65: WARNING: logic_arc_int_op__archdes_logical_operation_1.id (logic_arc_int_op__archdes_logical_operation_1): expected to consisting of this format: <Req Type>__<Abbreviations>__<Architectural Element>. [score_metamodel]
process_areas/architecture_design/_assets/architecture_modeling_example.rst:72: WARNING: logic_arc_int_op__archdes_logical_operation_2.id (logic_arc_int_op__archdes_logical_operation_2): expected to consisting of this format: <Req Type>__<Abbreviations>__<Architectural Element>. [score_metamodel]
process_areas/architecture_design/_assets/architecture_modeling_example.rst:79: WARNING: logic_arc_int_op__archdes_logical_operation_3.id (logic_arc_int_op__archdes_logical_operation_3): expected to consisting of this format: <Req Type>__<Abbreviations>__<Architectural Element>. [score_metamodel]
process_areas/architecture_design/_assets/architecture_modeling_example.rst:86: WARNING: logic_arc_int_op__archdes_logical_operation_4.id (logic_arc_int_op__archdes_logical_operation_4): expected to consisting of this format: <Req Type>__<Abbreviations>__<Architectural Element>. [score_metamodel]
process_areas/architecture_design/_assets/architecture_modeling_example.rst:93: WARNING: logic_arc_int_op__archdes_logical_operation_5.id (logic_arc_int_op__archdes_logical_operation_5): expected to consisting of this format: <Req Type>__<Abbreviations>__<Architectural Element>. [score_metamodel]
process_areas/architecture_design/_assets/architecture_modeling_example.rst:100: WARNING: logic_arc_int_op__archdes_logical_operation_6.id (logic_arc_int_op__archdes_logical_operation_6): expected to consisting of this format: <Req Type>__<Abbreviations>__<Architectural Element>. [score_metamodel]
process_areas/architecture_design/_assets/architecture_modeling_example.rst:107: WARNING: logic_arc_int_op__archdes_logical_operation_7.id (logic_arc_int_op__archdes_logical_operation_7): expected to consisting of this format: <Req Type>__<Abbreviations>__<Architectural Element>. [score_metamodel]
process_areas/architecture_design/_assets/architecture_modeling_example.rst:114: WARNING: logic_arc_int_op__archdes_logical_operation_8.id (logic_arc_int_op__archdes_logical_operation_8): expected to consisting of this format: <Req Type>__<Abbreviations>__<Architectural Element>. [score_metamodel]
process_areas/architecture_design/_assets/architecture_modeling_example.rst:125: WARNING: mod_view_sta__archdes_1.id (mod_view_sta__archdes_1): expected to consisting of this format: <Req Type>__<Abbreviations>__<Architectural Element>. [score_metamodel]
process_areas/architecture_design/_assets/architecture_modeling_example.rst:135: WARNING: mod_view_sta__archdes_2.id (mod_view_sta__archdes_2): expected to consisting of this format: <Req Type>__<Abbreviations>__<Architectural Element>. [score_metamodel]
process_areas/architecture_design/_assets/architecture_modeling_example.rst:148: WARNING: comp_arc_sta__archdes_component_1.id (comp_arc_sta__archdes_component_1): expected to consisting of this format: <Req Type>__<Abbreviations>__<Architectural Element>. [score_metamodel]
process_areas/architecture_design/_assets/architecture_modeling_example.rst:164: WARNING: comp_arc_sta__archdes_component_3.id (comp_arc_sta__archdes_component_3): expected to consisting of this format: <Req Type>__<Abbreviations>__<Architectural Element>. [score_metamodel]
process_areas/architecture_design/_assets/architecture_modeling_example.rst:180: WARNING: comp_arc_sta__archdes_sub_component_1.id (comp_arc_sta__archdes_sub_component_1): expected to consisting of this format: <Req Type>__<Abbreviations>__<Architectural Element>. [score_metamodel]
process_areas/architecture_design/_assets/architecture_modeling_example.rst:189: WARNING: comp_arc_sta__archdes_sub_component_2.id (comp_arc_sta__archdes_sub_component_2): expected to consisting of this format: <Req Type>__<Abbreviations>__<Architectural Element>. [score_metamodel]
process_areas/architecture_design/_assets/architecture_modeling_example.rst:198: WARNING: comp_arc_sta__archdes_sub_component_3.id (comp_arc_sta__archdes_sub_component_3): expected to consisting of this format: <Req Type>__<Abbreviations>__<Architectural Element>. [score_metamodel]
process_areas/architecture_design/_assets/architecture_modeling_example.rst:216: WARNING: feat_req__archdes_example_req.id (feat_req__archdes_example_req): expected to consisting of this format: <Req Type>__<Abbreviations>__<Architectural Element>. [score_metamodel]
process_areas/architecture_design/_assets/architecture_modeling_example.rst:226: WARNING: comp_req__archdes_example_req.id (comp_req__archdes_example_req): expected to consisting of this format: <Req Type>__<Abbreviations>__<Architectural Element>. [score_metamodel]
process_areas/architecture_design/architecture_concept.rst:126: WARNING: feat_arc_sta__feature_1.id (feat_arc_sta__feature_1): expected to consisting of this format: <Req Type>__<Abbreviations>__<Architectural Element>. [score_metamodel]
process_areas/architecture_design/architecture_concept.rst:162: WARNING: logic_arc_int__archdes_logical_interface_1.id (logic_arc_int__archdes_logical_interface_1): expected to consisting of this format: <Req Type>__<Abbreviations>__<Architectural Element>. [score_metamodel]
process_areas/architecture_design/architecture_concept.rst:182: WARNING: mod_view_sta__archdes_3.id (mod_view_sta__archdes_3): expected to consisting of this format: <Req Type>__<Abbreviations>__<Architectural Element>. [score_metamodel]
process_areas/architecture_design/architecture_concept.rst:201: WARNING: comp_arc_sta__archdes_component_2.id (comp_arc_sta__archdes_component_2): expected to consisting of this format: <Req Type>__<Abbreviations>__<Architectural Element>. [score_metamodel]
process_areas/architecture_design/architecture_concept.rst:231: WARNING: real_arc_int__archdes_component_interface_1.id (real_arc_int__archdes_component_interface_1): expected to consisting of this format: <Req Type>__<Abbreviations>__<Architectural Element>. [score_metamodel]
process_areas/architecture_design/architecture_getstrt.rst:112: WARNING: feat_arc_sta__archdes_getstrt.id (feat_arc_sta__archdes_getstrt): expected to consisting of this format: <Req Type>__<Abbreviations>__<Architectural Element>. [score_metamodel]
process_areas/architecture_design/architecture_getstrt.rst:144: WARNING: comp_arc_sta__component_getstrt.id (comp_arc_sta__component_getstrt): expected to consisting of this format: <Req Type>__<Abbreviations>__<Architectural Element>. [score_metamodel]
process_areas/architecture_design/architecture_getstrt.rst:225: WARNING: comp_arc_sta__component_manual_getstrt.id (comp_arc_sta__component_manual_getstrt): expected to consisting of this format: <Req Type>__<Abbreviations>__<Architectural Element>. [score_metamodel]

Copy link
Contributor

@MaximilianSoerenPollak MaximilianSoerenPollak left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems good.

@MaximilianSoerenPollak
Copy link
Contributor

@masc2023 feel free to merge this when it works for you. Looks good from my side.

@masc2023 masc2023 merged commit 7f76a94 into main May 16, 2025
3 checks passed
@masc2023 masc2023 deleted the masc2023_fix_refs2score branch May 16, 2025 15:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants