Skip to content

Conversation

@MaximilianSoerenPollak
Copy link
Contributor

@MaximilianSoerenPollak MaximilianSoerenPollak commented Aug 7, 2025

Closes #145

This is directly related to this PR in docs-as-code eclipse-score/docs-as-code#192

@MaximilianSoerenPollak
Copy link
Contributor Author

@PhilipPartsch Please have a look whenever you have time, in order to double check if any places are missed or anything needs changing.
I changed the ID's in regards to the rules we defined earlier.

@MaximilianSoerenPollak MaximilianSoerenPollak marked this pull request as draft August 7, 2025 13:50
Copy link
Contributor

@masc2023 masc2023 left a comment

Choose a reason for hiding this comment

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

See comment, you changed name of a PR, this is not correct

@MaximilianSoerenPollak
Copy link
Contributor Author

If I would take out the example_feature not being in the foldername check we currently have then these are the current warnings with the latest commit.

process_areas/change_management/guidance/change_management_reqs.rst:91: WARNING: gd_req__change__attr_types.id (gd_req__change__attr_types): expected to consist of this format: `<Req Type>__<Abbreviations>`. Only one '__' is allowed in this need's id. [score_metamodel]
process_areas/implementation/_assets/detailed_design_example.rst:28: WARNING: gd_req__example_feature__doc__approver.id (gd_req__example_feature__doc__approver): expected to consist of this format: `<Req Type>__<Abbreviations>__<Architectural Element>`. Only two '__' are allowed in this need's id. [score_metamodel]
process_areas/implementation/_assets/detailed_design_example.rst:28: WARNING: gd_req__example_feature__doc__approver.id (gd_req__example_feature__doc__approver): does not follow pattern `^dd_sta__[0-9a-z_]*$`. [score_metamodel]
process_areas/implementation/_assets/detailed_design_example.rst:42: WARNING: dd_dyn__example_feature_dd_example_dynamic.id (dd_dyn__example_feature_dd_example_dynamic): expected to consist of this format: `<Req Type>__<Abbreviations>__<Architectural Element>`. Only two '__' are allowed in this need's id. [score_metamodel]
process_areas/problem_resolution/guidance/problem_resolution_template.rst:20: WARNING: gd_temp__problem__template.id (gd_temp__problem__template): expected to consist of this format: `<Req Type>__<Abbreviations>`. Only one '__' is allowed in this need's id. [score_metamodel]
process_areas/quality_management/guidance/quality_process_reqs.rst:18: WARNING: gd_req__quality__report.id (gd_req__quality__report): expected to consist of this format: `<Req Type>__<Abbreviations>`. Only one '__' is allowed in this need's id. [score_metamodel]
process_areas/quality_management/quality_concept.rst:18: WARNING: doc_concept__quality__process.id (doc_concept__quality__process): expected to consist of this format: `<Req Type>__<Abbreviations>`. Only one '__' is allowed in this need's id. [score_metamodel]
process_areas/architecture_design/_assets/architecture_modeling_example.rst:41: WARNING: logic_arc_int__example_feature__archdes_logical_interface_2.id (logic_arc_int__example_feature__archdes_logical_interface_2): exceeds the maximum allowed length of 45 characters (current length: 59). [score_metamodel]
process_areas/architecture_design/_assets/architecture_modeling_example.rst:55: WARNING: logic_arc_int__example_feature__archdes_logical_interface_3.id (logic_arc_int__example_feature__archdes_logical_interface_3): exceeds the maximum allowed length of 45 characters (current length: 59). [score_metamodel]
process_areas/architecture_design/_assets/architecture_modeling_example.rst:65: WARNING: logic_arc_int_op__example_feature__archdes_logical_operation_1.id (logic_arc_int_op__example_feature__archdes_logical_operation_1): exceeds the maximum allowed length of 45 characters (current length: 62). [score_metamodel]
process_areas/architecture_design/_assets/architecture_modeling_example.rst:72: WARNING: logic_arc_int_op__example_feature__archdes_logical_operation_2.id (logic_arc_int_op__example_feature__archdes_logical_operation_2): exceeds the maximum allowed length of 45 characters (current length: 62). [score_metamodel]
process_areas/architecture_design/_assets/architecture_modeling_example.rst:79: WARNING: logic_arc_int_op__example_feature__archdes_logical_operation_3.id (logic_arc_int_op__example_feature__archdes_logical_operation_3): exceeds the maximum allowed length of 45 characters (current length: 62). [score_metamodel]
process_areas/architecture_design/_assets/architecture_modeling_example.rst:86: WARNING: logic_arc_int_op__example_feature__archdes_logical_operation_4.id (logic_arc_int_op__example_feature__archdes_logical_operation_4): exceeds the maximum allowed length of 45 characters (current length: 62). [score_metamodel]
process_areas/architecture_design/_assets/architecture_modeling_example.rst:93: WARNING: logic_arc_int_op__example_feature__archdes_logical_operation_5.id (logic_arc_int_op__example_feature__archdes_logical_operation_5): exceeds the maximum allowed length of 45 characters (current length: 62). [score_metamodel]
process_areas/architecture_design/_assets/architecture_modeling_example.rst:100: WARNING: logic_arc_int_op__example_feature__archdes_logical_operation_6.id (logic_arc_int_op__example_feature__archdes_logical_operation_6): exceeds the maximum allowed length of 45 characters (current length: 62). [score_metamodel]
process_areas/architecture_design/_assets/architecture_modeling_example.rst:107: WARNING: logic_arc_int_op__example_feature__archdes_logical_operation_7.id (logic_arc_int_op__example_feature__archdes_logical_operation_7): exceeds the maximum allowed length of 45 characters (current length: 62). [score_metamodel]
process_areas/architecture_design/_assets/architecture_modeling_example.rst:114: WARNING: logic_arc_int_op__example_feature__archdes_logical_operation_8.id (logic_arc_int_op__example_feature__archdes_logical_operation_8): exceeds the maximum allowed length of 45 characters (current length: 62). [score_metamodel]
process_areas/architecture_design/_assets/architecture_modeling_example.rst:148: WARNING: comp_arc_sta__example_feature__archdes_component_1.id (comp_arc_sta__example_feature__archdes_component_1): exceeds the maximum allowed length of 45 characters (current length: 50). [score_metamodel]
process_areas/architecture_design/_assets/architecture_modeling_example.rst:164: WARNING: comp_arc_sta__example_feature__archdes_component_3.id (comp_arc_sta__example_feature__archdes_component_3): exceeds the maximum allowed length of 45 characters (current length: 50). [score_metamodel]
process_areas/architecture_design/_assets/architecture_modeling_example.rst:180: WARNING: comp_arc_sta__example_feature__archdes_sub_component_1.id (comp_arc_sta__example_feature__archdes_sub_component_1): exceeds the maximum allowed length of 45 characters (current length: 54). [score_metamodel]
process_areas/architecture_design/_assets/architecture_modeling_example.rst:189: WARNING: comp_arc_sta__example_feature__archdes_sub_component_2.id (comp_arc_sta__example_feature__archdes_sub_component_2): exceeds the maximum allowed length of 45 characters (current length: 54). [score_metamodel]
process_areas/architecture_design/_assets/architecture_modeling_example.rst:198: WARNING: comp_arc_sta__example_feature__archdes_sub_component_3.id (comp_arc_sta__example_feature__archdes_sub_component_3): exceeds the maximum allowed length of 45 characters (current length: 54). [score_metamodel]
process_areas/architecture_design/_assets/architecture_modeling_example.rst:209: WARNING: stkh_req__example_feature__archdes_example_req.id (stkh_req__example_feature__archdes_example_req): exceeds the maximum allowed length of 45 characters (current length: 46). [score_metamodel]
process_areas/architecture_design/_assets/architecture_modeling_example.rst:219: WARNING: feat_req__example_feature__archdes_example_req.id (feat_req__example_feature__archdes_example_req): exceeds the maximum allowed length of 45 characters (current length: 46). [score_metamodel]
process_areas/architecture_design/_assets/architecture_modeling_example.rst:229: WARNING: comp_req__example_feature__archdes_example_req.id (comp_req__example_feature__archdes_example_req): exceeds the maximum allowed length of 45 characters (current length: 46). [score_metamodel]
process_areas/architecture_design/architecture_concept.rst:162: WARNING: logic_arc_int__example_feature__archdes_logical_interface_1.id (logic_arc_int__example_feature__archdes_logical_interface_1): exceeds the maximum allowed length of 45 characters (current length: 59). [score_metamodel]
process_areas/architecture_design/architecture_concept.rst:201: WARNING: comp_arc_sta__example_feature__archdes_component_2.id (comp_arc_sta__example_feature__archdes_component_2): exceeds the maximum allowed length of 45 characters (current length: 50). [score_metamodel]
process_areas/architecture_design/architecture_concept.rst:231: WARNING: real_arc_int__example_feature__archdes_component_interface_1.id (real_arc_int__example_feature__archdes_component_interface_1): exceeds the maximum allowed length of 45 characters (current length: 60). [score_metamodel]
process_areas/architecture_design/architecture_getstrt.rst:112: WARNING: feat_arc_sta__example_feature__archdes_getstrt.id (feat_arc_sta__example_feature__archdes_getstrt): exceeds the maximum allowed length of 45 characters (current length: 46). [score_metamodel]
process_areas/architecture_design/architecture_getstrt.rst:144: WARNING: comp_arc_sta__example_feature__component_getstrt.id (comp_arc_sta__example_feature__component_getstrt): exceeds the maximum allowed length of 45 characters (current length: 48). [score_metamodel]
process_areas/architecture_design/architecture_getstrt.rst:225: WARNING: comp_arc_sta__example_feature__component_manual_getstrt.id (comp_arc_sta__example_feature__component_manual_getstrt): exceeds the maximum allowed length of 45 characters (current length: 55). [score_metamodel]
process_areas/verification/workproducts.rst:23: WARNING: wp__verification__plan.id (wp__verification__plan): expected to consist of this format: `<Req Type>__<Abbreviations>`. Only one '__' is allowed in this need's id. [score_metamodel]
process_areas/verification/workproducts.rst:34: WARNING: wp__verification__platform_test.id (wp__verification__platform_test): expected to consist of this format: `<Req Type>__<Abbreviations>`. Only one '__' is allowed in this need's id. [score_metamodel]
process_areas/verification/workproducts.rst:43: WARNING: wp__verification__platform_ver_report.id (wp__verification__platform_ver_report): expected to consist of this format: `<Req Type>__<Abbreviations>`. Only one '__' is allowed in this need's id. [score_metamodel]
process_areas/verification/workproducts.rst:60: WARNING: wp__verification__feat_int_test.id (wp__verification__feat_int_test): expected to consist of this format: `<Req Type>__<Abbreviations>`. Only one '__' is allowed in this need's id. [score_metamodel]
process_areas/verification/workproducts.rst:75: WARNING: wp__verification__module_ver_report.id (wp__verification__module_ver_report): expected to consist of this format: `<Req Type>__<Abbreviations>`. Only one '__' is allowed in this need's id. [score_metamodel]
process_areas/verification/workproducts.rst:96: WARNING: wp__verification__comp_int_test.id (wp__verification__comp_int_test): expected to consist of this format: `<Req Type>__<Abbreviations>`. Only one '__' is allowed in this need's id. [score_metamodel]
process_areas/verification/workproducts.rst:114: WARNING: wp__verification__sw_unit_test.id (wp__verification__sw_unit_test): expected to consist of this format: `<Req Type>__<Abbreviations>`. Only one '__' is allowed in this need's id. [score_metamodel]

So still some missing from my side, and some of them too long.

Should we then change the max allowed length, to remove these max lenght things? Or what would be the best case solution here?

@MaximilianSoerenPollak MaximilianSoerenPollak marked this pull request as ready for review August 11, 2025 10:21
@github-actions
Copy link

The created documentation from the pull request is available at: docu-html

Copy link
Contributor

@masc2023 masc2023 left a comment

Choose a reason for hiding this comment

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

Vote for 1.1.1 as new release

@MaximilianSoerenPollak MaximilianSoerenPollak merged commit d032f1f into main Aug 11, 2025
5 checks passed
@MaximilianSoerenPollak MaximilianSoerenPollak deleted the MSP_change_ids branch August 11, 2025 12:19
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.

Bug: Need ID's need fixing

4 participants