Skip to content

Conversation

@LittleHuba
Copy link
Contributor

@LittleHuba LittleHuba commented Feb 14, 2025

This PR brings the high-level architecture of LoLa to the IPC feature. It is the first step towards breaking down the feature requirements into component requirements.

The focus of the architecture documentation is twofold.
Firstly, we show the overall concept behind the solution
Secondly, we discuss the key aspects of the feature request, to show how they are solved.

The second point is done implicitly while explaining the overall concept, to have a better flow of the documentation.

@github-actions
Copy link

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

@LittleHuba LittleHuba linked an issue Feb 17, 2025 that may be closed by this pull request
@FScholPer
Copy link
Contributor

visualization seems not to work:
image

@LittleHuba
Copy link
Contributor Author

@ltekieli could you help investigate this?
Locally building incrementally visualizes the diagrams correctly.

@ltekieli
Copy link
Member

ltekieli commented Feb 18, 2025

@AlexanderLanin @MaximilianSoerenPollak dot is missing from the CI installation.

- name: Install graphviz
  run: sudo apt install -y graphviz

@LittleHuba should do the trick.

@AlexanderLanin
Copy link
Member

@ltekieli in general PlantUML in CI is working fine: https://eclipse-score.github.io/score/main/guidance/docs-as-code.html#plantuml

@ltekieli
Copy link
Member

@ltekieli in general PlantUML in CI is working fine: https://eclipse-score.github.io/score/main/guidance/docs-as-code.html#plantuml

It seems plantuml does not use dot always, but in this case it's definately complaining about it missing.

@AlexanderLanin
Copy link
Member

@ltekieli in general PlantUML in CI is working fine: https://eclipse-score.github.io/score/main/guidance/docs-as-code.html#plantuml

It seems plantuml does not use dot always, but in this case it's definately complaining about it missing.

You are right. It depends on the diagram type whether dot is required. I'll create a new issue for this.
Reference: https://chatgpt.com/share/67b46957-d804-800a-aedd-b148068caab9

@github-actions
Copy link

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

@github-actions
Copy link

github-actions bot commented Mar 12, 2025

License Check Results

🚀 The license check preparation job ran successfully.

Status: ⚠️ Needs Review

Click to expand output
2025/03/21 15:11:11 Downloading https://releases.bazel.build/7.4.0/release/bazel-7.4.0-linux-x86_64...
Extracting Bazel installation...
Starting local Bazel server and connecting to it...
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Loading: 
Loading: 0 packages loaded
Loading: 0 packages loaded
    currently loading: docs
Loading: 0 packages loaded
    currently loading: docs
Loading: 0 packages loaded
    currently loading: docs
Analyzing: target //docs:license.check.python (1 packages loaded, 0 targets configured)
Analyzing: target //docs:license.check.python (1 packages loaded, 0 targets configured)

Analyzing: target //docs:license.check.python (91 packages loaded, 10 targets configured)

Analyzing: target //docs:license.check.python (97 packages loaded, 10 targets configured)

Analyzing: target //docs:license.check.python (123 packages loaded, 615 targets configured)

Analyzing: target //docs:license.check.python (130 packages loaded, 812 targets configured)

Analyzing: target //docs:license.check.python (139 packages loaded, 2402 targets configured)

Analyzing: target //docs:license.check.python (144 packages loaded, 2465 targets configured)

Analyzing: target //docs:license.check.python (145 packages loaded, 2465 targets configured)

Analyzing: target //docs:license.check.python (147 packages loaded, 4487 targets configured)

INFO: Analyzed target //docs:license.check.python (149 packages loaded, 4736 targets configured).
[3 / 10] [Prepa] Creating source manifest for //tools/dash/formatters:dash_format_converter [for tool]
[9 / 13] JavaToolchainCompileClasses external/rules_java~/toolchains/platformclasspath_classes; 0s processwrapper-sandbox ... (2 actions running)
[11 / 13] JavaToolchainCompileBootClasspath external/rules_java~/toolchains/platformclasspath.jar; 0s processwrapper-sandbox
INFO: Found 1 target...
Target //docs:license.check.python up-to-date:
  bazel-bin/docs/license.check.python
  bazel-bin/docs/license.check.python.jar
INFO: Elapsed time: 22.667s, Critical Path: 2.50s
INFO: 13 processes: 9 internal, 3 processwrapper-sandbox, 1 worker.
INFO: Build completed successfully, 13 total actions
INFO: Running command line: bazel-bin/docs/license.check.python docs/formatted.txt -review -project automotive.score -repo https://github.com/eclipse-score/score -token otyhZ4eaRYK1tKLNNF-Y
[main] INFO Querying Eclipse Foundation for license data for 69 items.
[main] INFO Found 45 items.
[main] INFO Querying ClearlyDefined for license data for 26 items.
[main] INFO Found 26 items.
[main] INFO License information could not be automatically verified for the following content:
[main] INFO 
[main] INFO pypi/pypi/-/debugpy/1.8.12
[main] INFO pypi/pypi/-/docutils/0.21.2
[main] INFO 
[main] INFO This content is either not correctly mapped by the system, or requires review.
[main] INFO A review is required for pypi/pypi/-/docutils/0.21.2.
[main] INFO A review request already exists https://gitlab.eclipse.org/eclipsefdn/emo-team/iplab/-/issues/19880 .
[main] INFO A review is required for pypi/pypi/-/debugpy/1.8.12.
[main] INFO A review request already exists https://gitlab.eclipse.org/eclipsefdn/emo-team/iplab/-/issues/19903 .

LittleHuba and others added 3 commits March 13, 2025 17:20
- create interface
- resolve links
@LittleHuba LittleHuba marked this pull request as ready for review March 17, 2025 10:35
An own directory helps better structure
the toc and sort assets.
Do not show all headings in feature request in TOC.
Show architecture and roadmap in TOC.
Separate architecture into feature and component.
For now component architecture is stored in feature tree because
of tooling issues.
@LittleHuba LittleHuba merged commit 1c668af into main Mar 24, 2025
10 checks passed
@LittleHuba LittleHuba deleted the ulhu_lola_hla branch March 24, 2025 11:27
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.

Create Architecture Documentation for Communication Framework

7 participants