add documentation examples by RolandJentschETAS · Pull Request #58 · eclipse-score/module_template

RolandJentschETAS · 2026-04-01T09:34:45Z

Move the documentation examples from process documentation to module template.

See belonging PR eclipse-score/process_description#632 in process.

github-actions · 2026-04-01T09:38:30Z

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]
2026/04/23 06:05:01 Downloading https://releases.bazel.build/8.3.0/release/bazel-8.3.0-linux-x86_64...
Extracting Bazel installation...
Starting local Bazel server (8.3.0) and connecting to it...
INFO: Invocation ID: 36774978-e63e-4ac4-9eb5-d02824dd5743
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: 
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 (77 packages loaded, 9 targets configured)

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

Analyzing: target //:license-check (126 packages loaded, 254 targets configured)

Analyzing: target //:license-check (146 packages loaded, 2943 targets configured)

Analyzing: target //:license-check (147 packages loaded, 4268 targets configured)

Analyzing: target //:license-check (151 packages loaded, 7581 targets configured)

Analyzing: target //:license-check (151 packages loaded, 7586 targets configured)

Analyzing: target //:license-check (151 packages loaded, 7586 targets configured)

Analyzing: target //:license-check (151 packages loaded, 7586 targets configured)

Analyzing: target //:license-check (151 packages loaded, 7586 targets configured)

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

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

Analyzing: target //:license-check (158 packages loaded, 9729 targets configured)

Analyzing: target //:license-check (158 packages loaded, 9729 targets configured)

Analyzing: target //:license-check (158 packages loaded, 9729 targets configured)

INFO: Analyzed target //:license-check (159 packages loaded, 11664 targets configured).
[12 / 16] [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
[14 / 16] JavaToolchainCompileBootClasspath external/rules_java+/toolchains/platformclasspath.jar; 0s disk-cache, processwrapper-sandbox
[15 / 16] Building license.check.license_check.jar (); 0s disk-cache, multiplex-worker
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: 206.836s, Critical Path: 2.50s
INFO: 16 processes: 12 internal, 3 processwrapper-sandbox, 1 worker.
INFO: Build completed successfully, 16 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 · 2026-04-01T09:39:22Z

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

This reverts commit 683d5df.

MaximilianSoerenPollak · 2026-04-01T11:46:49Z

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

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

Lets discuss this outside this PR.

MaximilianSoerenPollak · 2026-04-01T11:49:07Z

+| `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) |


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

This is unchanged (was there also before PR). We have to check that.

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

arsibo · 2026-04-02T10:28:28Z

After discussion with Roland and the discussion in the process meeting (02.04.2026)
We will prepare a DR. We discussed the point in January , but haven't finalized it yet (#40)

In case that the new DR can not be decided in the next two weeks, we need a workaround step for that PR.
Maybe we can do it as intermediate solution.

aschemmel-tech · 2026-04-02T11:38:38Z

The folder structure already documented in https://eclipse-score.github.io/score/main/contribute/general/folder.html#module-folder-structure does not have the problem as I understand (the entry point for sphinx would be <module_name> folder). Why not use this? But I understand that we would not like to have a path which is like https://github.com/eclipse-score/<repository_name>/<module_name> because these may be the same, but please consider that we defined "This Delivery Container can contain one or more Dependable Elements" in https://eclipse-score.github.io/process_description/main/general_concepts/score_building_blocks_concept.html so a reposity could contain more than one module.

aschemmel-tech

see inline comments

aschemmel-tech

some more topics found

aschemmel-tech

comments resolved apart from minor stuff

add documentation examples

a4b9193

github-project-automation Bot added this to INF - Infrastructure Community Apr 1, 2026

github-project-automation Bot moved this to Backlog in INF - Infrastructure Community Apr 1, 2026

RolandJentschETAS added 5 commits April 1, 2026 11:46

fix copyright check

d663e72

add copyright

bf89f92

add newline at end of file

683d5df

Revert "add newline at end of file"

c23e2f9

This reverts commit 683d5df.

add newlines

87736d6

MaximilianSoerenPollak reviewed Apr 1, 2026

View reviewed changes

Comment thread docs/score/example_component/component_architecture_template.rst Outdated

MaximilianSoerenPollak reviewed Apr 1, 2026

View reviewed changes

RolandJentschETAS mentioned this pull request Apr 2, 2026

Start to move examples to template module repository eclipse-score/process_description#632

Merged

RolandJentschETAS mentioned this pull request Apr 2, 2026

Implement DR-007 eclipse-score/docs-as-code#392

Open

RolandJentschETAS mentioned this pull request Apr 2, 2026

EPIC: Metamodel Usability Adaptions eclipse-score/process_description#450

Open

2 tasks

RolandJentschETAS added 7 commits April 7, 2026 13:50

take over general structure according to process

dd338b2

use folder template from process repo

a368dd9

fix commit hash

ef83c1f

fix strange format error

90b3293

structuring module documentation

3e7930d

add directory tree picture

932dd61

add some comments

32f0836

aschemmel-tech requested changes Apr 9, 2026

View reviewed changes

Comment thread docs/stakeholder_requirements_template.rst

Comment thread score/component_example/docs/safety_analysis/aou_requirements_template.rst

Comment thread examples/docs/architecture_modeling_example.rst

Comment thread docs/features/index.rst

RolandJentschETAS added 4 commits April 9, 2026 11:45

change to include folder approach

66f9fae

use main path instead of link

f00943c

fix builds

e781916

remove stakeholder reqs

60aa73e

RolandJentschETAS and others added 14 commits April 9, 2026 14:45

remove stakeholder reqs

c14608e

temp fix for docs at root

eff3896

fix links

e981b1d

add any necessary files

7f4f5b5

add main index file

bfee7e5

move aou

6fd9311

move aou

59bc409

update folder structure entry picture

45b433d

empty gitkeep

778b735

rework test folders

4fd4bcf

small adaption of the folder structure

590638c

remove CR content

ea1cf04

remove CR content

6f7f588

move verification

668691f

aschemmel-tech requested changes Apr 15, 2026

View reviewed changes

RolandJentschETAS added 4 commits April 17, 2026 14:25

add review results

db86d4e

minor changes

c1bec9b

add hints

9d9611f

add missing wp

9d90c3b

MaximilianSoerenPollak mentioned this pull request Apr 21, 2026

docs: add Sphinx documentation site with Bazel eclipse-score/itf#88

Open

5 tasks

add hint

31ed8a9

RolandJentschETAS commented Apr 22, 2026

View reviewed changes

Comment thread index.rst Outdated

RolandJentschETAS added 2 commits April 22, 2026 15:58

fix review findings

91e451f

add notes

70b1e0e

aschemmel-tech approved these changes Apr 23, 2026

View reviewed changes

RolandJentschETAS merged commit 158bd57 into main Apr 23, 2026
9 checks passed

RolandJentschETAS deleted the improvement_add_documentation_examples branch April 23, 2026 11:49

github-project-automation Bot moved this from Backlog to Done in INF - Infrastructure Community Apr 23, 2026

Conversation

RolandJentschETAS commented Apr 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Apr 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

License Check Results

Uh oh!

github-actions Bot commented Apr 1, 2026

Uh oh!

MaximilianSoerenPollak Apr 1, 2026

Choose a reason for hiding this comment

Uh oh!

RolandJentschETAS Apr 1, 2026

Choose a reason for hiding this comment

Uh oh!

RolandJentschETAS Apr 13, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

MaximilianSoerenPollak Apr 1, 2026

Choose a reason for hiding this comment

Uh oh!

RolandJentschETAS Apr 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

masc2023 Apr 1, 2026

Choose a reason for hiding this comment

Uh oh!

arsibo commented Apr 2, 2026

Uh oh!

aschemmel-tech commented Apr 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

aschemmel-tech left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

aschemmel-tech left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

aschemmel-tech left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

RolandJentschETAS commented Apr 1, 2026 •

edited

Loading

github-actions Bot commented Apr 1, 2026 •

edited

Loading

RolandJentschETAS Apr 1, 2026 •

edited

Loading

aschemmel-tech commented Apr 2, 2026 •

edited

Loading