Resolve warnings from docs-as-code metamodel checks

[masc2023]

Warnings depending on the doc-as-code metamodel shall be resolved

Compare #11

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: . [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: . [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: . [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: . [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: . [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: . [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: . [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: . [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: . [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: . [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: . [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: . [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: . [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: . [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: . [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: . [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: . [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: . [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: . [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: . [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: . [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: . [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: . [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: . [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: . [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: . [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: . [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: . [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: . [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: . [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: . [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: . [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: . [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: . [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: . [score_metamodel]

[MaximilianSoerenPollak]

Copy from slack:

I have a question regarding this:
https://eclipse-score.github.io/score/main/contribute/general/naming.html#naming-convention-needs which is referenced here: https://eclipse-score.github.io/score/main/process/process_areas/requirements_engineering/guidance/requirements_process_reqs.html#gd_req_[…]attr_uid
Could you give me a list of all need types that are meant by 'process UIDs'?

[MaximilianSoerenPollak]

Currently in this process repository these 'types' are used:

{'dd_sta', 'sw_unit_int', 'logic_arc_int', 'comp_arc_sta', 'sw_unit', 'feat_arc_sta', 'std_wp', 'gd_guidl', 'stkh_req', 'dd_dyn', 'feat_req', 'workflow', 'gd_chklst', 'std_req', 'role', 'comp_req', 'doc_concept', 'gd_temp', 'document', 'gd_method', 'logic_arc_int_op', 'mod_view_sta', 'gd_req', 'workproduct', 'real_arc_int', 'doc_getstrt'}

Would it be correct to assume that these types are not 'forced' to adhere to a 3 split structure (splitting on __ and getting 3 parts) but can be instead a 2 part one?
If this is the case I can build it in.
However, this needs to be true for ALL need types, no matter where they are located. Otherwise this fix would be wrong.

---

Assumption:

All needs no matter their location in this or any other repository of the abovementioned type can be passed into the check and do not need to fullfill a '3 split structure'. They do however need to fullfill a '2 split structure'

Is this a correct assumption?

@masc2023

[masc2023]

For the ones for process meta model, yes assumption is correct, other are used as example in process currently, but there are also used in other repos, for that they are not correct, I assume, may to changed in process in future or even removed to other places

Process only
{ 'std_wp', 'gd_guidl', 'workflow', 'gd_chklst', 'std_req', 'role', , 'doc_concept', 'gd_temp', 'gd_method', 'gd_req', 'workproduct', 'doc_getstrt'}
compare also https://github.com/eclipse-score/docs-as-code/blob/main/src/extensions/score_metamodel/metamodel.yaml

[MaximilianSoerenPollak]

So if I read this correctly that means we have to exclude those ID's that you posted as well as any other ideas that are inside this repository but ONLY if they are in this repository. Is this correct?

The issue is that it seems very 'specific' to check if it's inside one of the folders that is in this repository.

A simpler solution might be to just move the conf.py and index.rst up one, as then 'process' appears in the documentation name, as it did before, and we could check if the docname starts with process. Not ideal but at least a bit better than adding all the folder names.

[masc2023]

not sure, if I got is, the process meta model topics, should be used only in process_description folder, if used elsewhere, it is wrong, all others may used over the place, and yes, if process is in the name, it could be skipped check, yes

[MaximilianSoerenPollak]

I think easiest to just talk about this in the next meeting to avoid writing books & confusion. :) Will then update here with the result.

[MaximilianSoerenPollak]

These warnings will be solved once the new 'docs_as_code' is released and used in this repo (0.2.4). Locally verified that these do not appear anymore.

[AlexanderLanin]

Can we use regex on the id in the yaml file, instead of a python check?

[MaximilianSoerenPollak]

I have not really thought about it much. It seems weird / rather complex to do this in regex, but it might be possible.

In my mind this would be something that hopefully has a clearer / better solution when we adopt more/all from the useblocks metamodel design thing.

[AlexanderLanin]

^stkh_req__[^_]+__[^_]+$