Skip to content

switch link direction between feat and log_arc_int - #754

Open
RolandJentschETAS wants to merge 7 commits into
eclipse-score:mainfrom
etas-contrib:improvement_switch_feat_log_int_direction
Open

switch link direction between feat and log_arc_int#754
RolandJentschETAS wants to merge 7 commits into
eclipse-score:mainfrom
etas-contrib:improvement_switch_feat_log_int_direction

Conversation

@RolandJentschETAS

Copy link
Copy Markdown
Contributor

This pull request updates the documentation and requirements to standardize the use of the included_by attribute for linking features and logical architectural interfaces, replacing the previous use of includes. It also updates related guidance and limitations to reflect this change.

Attribute linking and documentation updates:

  • Updated the Logical Interfaces section in architecture/index.rst to add the :included_by: attribute, clarifying the link from features to logical interfaces.
  • Removed the :includes: attribute from the Abstract section in feature_name/index.rst to align with the new linking approach.
  • Removed the :includes: attribute from the rendered feature example section in architecture_concept.rst for consistency.
  • Updated the limitations list in architecture_concept.rst to mention that the included_by attribute is now in use, in addition to includes, uses, and implements.

Guidance and requirements update:

  • Revised the architectural design check in architecture_process_reqs.rst to require that interfaces are linked to features via the included_by attribute, instead of includes, for consistency in interface-feature relationships.

@github-actions

Copy link
Copy Markdown

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

@masc2023 masc2023 Jul 30, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@aschemmel-tech aschemmel-tech Jul 30, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

another one is in https://eclipse-score.github.io/process_description/main/process_areas/architecture_design/guidance/architecture_process_reqs.html#gd_req__arch_build_blocks_corr
and when you are at it, please check if the optional "includes" link from logic_arc_int to logic_arc_int_op makes sense? wouldn't this be added automatically as back-link?

From @RolandJentschETAS : That's independent of the current change. Can we discuss it separate ? For example in the next process meeting, because that shows the current state in docs_as_code meta model.

@RolandJentschETAS RolandJentschETAS Jul 30, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

The other 2 pictures are also changed.
The traceability pictures does not contain the logical interface. Therefore they are fine.
The requirement picture is now also changed.
The "logic_arc_int to logic_arc_int_op" is the current state in the metamodel of docs as code. So both are defined independently. At this time when the picture was updated, I added the status quo of the yaml. I propose to discuss this independently from the current PR, because the link direction concept is not clear for me. The link itself is used in the launchmanager for the lifecycle interface.

@masc2023 masc2023 Jul 30, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

But fulfills is now optional, must be removed here,
https://eclipse-score.github.io/process_description/main/general_concepts/score_building_blocks_concept.html#hint-for-tool-implementation

that images shows only mandatory links

@RolandJentschETAS RolandJentschETAS Jul 31, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I have no access to this link ... But it is the simplified picture ? Have done it.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@aschemmel-tech aschemmel-tech left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

checked for completeness, found one additional place to modify

@aschemmel-tech aschemmel-tech Jul 30, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

another one is in https://eclipse-score.github.io/process_description/main/process_areas/architecture_design/guidance/architecture_process_reqs.html#gd_req__arch_build_blocks_corr
and when you are at it, please check if the optional "includes" link from logic_arc_int to logic_arc_int_op makes sense? wouldn't this be added automatically as back-link?

From @RolandJentschETAS : That's independent of the current change. Can we discuss it separate ? For example in the next process meeting, because that shows the current state in docs_as_code meta model.

@RolandJentschETAS

Copy link
Copy Markdown
Contributor Author

checked for completeness, found one additional place to modify

Fixed

@masc2023 masc2023 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

my findings resolved

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