Skip to content

add documentation examples#58

Open
RolandJentschETAS wants to merge 6 commits intomainfrom
improvement_add_documentation_examples
Open

add documentation examples#58
RolandJentschETAS wants to merge 6 commits intomainfrom
improvement_add_documentation_examples

Conversation

@RolandJentschETAS
Copy link
Copy Markdown
Contributor

@RolandJentschETAS RolandJentschETAS commented Apr 1, 2026

No description provided.

@github-actions
Copy link
Copy Markdown

github-actions bot commented Apr 1, 2026 •
edited
Loading

License Check Results

🚀 The license check job ran with the Bazel command:

bazel run --lockfile_mode=error //:license-check

Status: ⚠️ Needs Review

Click to expand output 
[License Check Output]
Extracting Bazel installation...
Starting local Bazel server (8.3.0) and connecting to it...
INFO: Invocation ID: e0a02756-4d5d-481a-ab13-af83ae5e3d92
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Loading: 
Loading: 0 packages loaded
Loading: 0 packages loaded
Loading: 0 packages loaded
    currently loading: 
Loading: 0 packages loaded
    currently loading: 
Analyzing: target //:license-check (1 packages loaded, 0 targets configured)
Analyzing: target //:license-check (1 packages loaded, 0 targets configured)

Analyzing: target //:license-check (28 packages loaded, 9 targets configured)

Analyzing: target //:license-check (79 packages loaded, 9 targets configured)

Analyzing: target //:license-check (84 packages loaded, 9 targets configured)

Analyzing: target //:license-check (144 packages loaded, 1748 targets configured)

Analyzing: target //:license-check (149 packages loaded, 2793 targets configured)

Analyzing: target //:license-check (152 packages loaded, 2804 targets configured)

Analyzing: target //:license-check (152 packages loaded, 2804 targets configured)

Analyzing: target //:license-check (155 packages loaded, 4811 targets configured)

Analyzing: target //:license-check (156 packages loaded, 4935 targets configured)

Analyzing: target //:license-check (156 packages loaded, 4935 targets configured)

Analyzing: target //:license-check (157 packages loaded, 5055 targets configured)

Analyzing: target //:license-check (157 packages loaded, 5055 targets configured)

Analyzing: target //:license-check (157 packages loaded, 5055 targets configured)

INFO: Analyzed target //:license-check (158 packages loaded, 6990 targets configured).
[9 / 13] [Prepa] JavaToolchainCompileClasses external/rules_java+/toolchains/platformclasspath_classes
INFO: From Generating Dash formatted dependency file ...:
INFO: Successfully converted 2 packages from Cargo.lock to bazel-out/k8-fastbuild/bin/formatted.txt
[11 / 13] JavaToolchainCompileBootClasspath external/rules_java+/toolchains/platformclasspath.jar; 0s disk-cache, processwrapper-sandbox
INFO: Found 1 target...
Target //:license.check.license_check up-to-date:
  bazel-bin/license.check.license_check
  bazel-bin/license.check.license_check.jar
INFO: Elapsed time: 193.762s, Critical Path: 2.33s
INFO: 13 processes: 9 internal, 3 processwrapper-sandbox, 1 worker.
INFO: Build completed successfully, 13 total actions
INFO: Running command line: bazel-bin/license.check.license_check ./formatted.txt <args omitted>
usage: org.eclipse.dash.licenses.cli.Main [-batch <int>] [-cd <url>]
       [-confidence <int>] [-ef <url>] [-excludeSources <sources>] [-help] [-lic
       <url>] [-project <shortname>] [-repo <url>] [-review] [-summary <file>]
       [-timeout <seconds>] [-token <token>]

@github-actions
Copy link
Copy Markdown

github-actions bot commented Apr 1, 2026

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

MaximilianSoerenPollak
MaximilianSoerenPollak reviewed Apr 1, 2026
View reviewed changes
score/example_component/docs/detailed_design_example.rst
:status: valid

Placeholder for the description that will be generated from doxygen No newline at end of file
Placeholder for the description that will be generated from doxygen
Copy link
Copy Markdown
Contributor

@MaximilianSoerenPollak MaximilianSoerenPollak Apr 1, 2026

Choose a reason for hiding this comment

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

We aren't using doxygen, is this a typo / old copy paste error?

Copy link
Copy Markdown
Contributor Author

@RolandJentschETAS RolandJentschETAS Apr 1, 2026

Choose a reason for hiding this comment

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

The description itself is directly moved from process description. Maybe the process description was wrong.

MaximilianSoerenPollak
MaximilianSoerenPollak reviewed Apr 1, 2026
View reviewed changes
docs/score/example_component/component_architecture_template.rst
# SPDX-License-Identifier: Apache-2.0
# *******************************************************************************
.. include:: ../../../score/example_component/docs/component_architecture_template.rst
Copy link
Copy Markdown
Contributor

@MaximilianSoerenPollak MaximilianSoerenPollak Apr 1, 2026

Choose a reason for hiding this comment

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

I don't understand this, can you explain?
Why is this included and not just in one place?

Copy link
Copy Markdown
Contributor Author

@RolandJentschETAS RolandJentschETAS Apr 1, 2026

Choose a reason for hiding this comment

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

According to the documentation guidelines the component documentation is located nearby the components. That means in the docs folder of the component. If I want to refer to that from the architecture I have to link it in this way.

Copy link
Copy Markdown
Contributor Author

@RolandJentschETAS RolandJentschETAS Apr 1, 2026

Choose a reason for hiding this comment

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

Not sure how to solve different parts in one repo in an other way. Maybe by an index.rst at top level.

Copy link
Copy Markdown
Contributor

@MaximilianSoerenPollak MaximilianSoerenPollak Apr 1, 2026

Choose a reason for hiding this comment

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

There currently isn't a way to have different TOP LEVEL doc folders. They all have to be in a single combined folder.

MaximilianSoerenPollak
MaximilianSoerenPollak reviewed Apr 1, 2026
View reviewed changes
README.md
| `score/` | Source files and Unit Tests for the module |
| `tests/` | Component and Feature Integration Tests (CIT&FIT) |
| `examples/` | Example files used for guidance |
| `docs/` | Documentation (Doxygen for C++ / mdBook for Rust) |
Copy link
Copy Markdown
Contributor

@MaximilianSoerenPollak MaximilianSoerenPollak Apr 1, 2026

Choose a reason for hiding this comment

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

As far as I know doxygen is not used currently.
OR am I on old information?

Copy link
Copy Markdown
Contributor Author

@RolandJentschETAS RolandJentschETAS Apr 1, 2026

Choose a reason for hiding this comment

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

This is unchanged. We have to check that.

Copy link
Copy Markdown
Contributor

@masc2023 masc2023 Apr 1, 2026

Choose a reason for hiding this comment

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

Implementation process is not finalised yet, that was planned for implementation, detailed design

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

Reviewers

@MaximilianSoerenPollak MaximilianSoerenPollak MaximilianSoerenPollak left review comments

@masc2023 masc2023 masc2023 left review comments

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

INF - Infrastructure Community
Status: Backlog

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@RolandJentschETAS @MaximilianSoerenPollak @masc2023