Skip to content

Replace arch and req to S-CORE#2974

Open
PandaeDo wants to merge 2 commits into
eclipse-score:mainfrom
qorix-group:vohae_persistency_documents
Open

Replace arch and req to S-CORE#2974
PandaeDo wants to merge 2 commits into
eclipse-score:mainfrom
qorix-group:vohae_persistency_documents

Conversation

@PandaeDo

@PandaeDo PandaeDo commented Jun 11, 2026

Copy link
Copy Markdown
Contributor

After clarification in process community today, documents of architecture and requirements, also the feature request will be placed again in S-CORE. #2964

@github-actions

Copy link
Copy Markdown

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

:status: valid
:belongs_to: feat__persistency

.. uml:: _assets/kvs_static_view.puml

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.

Is there any reason to use puml instead of the integrated draw function of sphinx ? Outside the appearance (all other features look different) it does not allow the automated drawing, but needs manual created drawings and needs manual checks.

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 don't know the exact reason. But I guess this was the stand of knowledge the authors had as the initially created the architecture over one year ago. But I take this as a point for the feature team meeting next week. We have some changes and will plan to update documents. This might be a good chance also to update the architecture as you described.

@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.

not all architecture elements are needed on score repo, see inline comments

Comment thread docs/features/persistency/index.rst Outdated

.. toctree::
architecture/index.rst
architecture/chklst_arc_inspection.rst

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.

architecture checklist should be stored in the module repo, as mainly the static and dynamic views are inspected which are located there. See also https://eclipse-score.github.io/score/main/contribute/general/folder.html#platform-folder-structure

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.

Changed as suggested


.. needextend:: is_external == False and "persistency/requirements" in docname
:+tags: persistency

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.

feature level aou were removed here, these should be in module repository now, see eclipse-score/persistency#296 - but not all are covered. Missing is aou_req__persistency__appl_design. Why?

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.

It was removed because of a finding regarding inconsistent aos #2667

:status: valid
:provides: logic_arc_int__persistency__interface

.. comp:: persistency::kvs

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.

The full architecture on feature level is part of the module repository. Here should only be the feature definition and the (logical) interfaces of the feature.

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.

Changed as suggested

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Backlog
Status: No status

Development

Successfully merging this pull request may close these issues.

3 participants