Skip to content

Restructure documentation to meet S-CORE conventions#123

Draft
BjoernAtBosch wants to merge 2 commits into
eclipse-score:mainfrom
etas-contrib:bjoernatbosch_restructure_documentation
Draft

Restructure documentation to meet S-CORE conventions#123
BjoernAtBosch wants to merge 2 commits into
eclipse-score:mainfrom
etas-contrib:bjoernatbosch_restructure_documentation

Conversation

@BjoernAtBosch

@BjoernAtBosch BjoernAtBosch commented Jul 10, 2026

Copy link
Copy Markdown
Contributor

I started this due to issue #40. Didn't know about #121 and #84 until today.

This PR assumes that Time is a single feature with components time, time_slave, and time_daemon (according to choosing option B of #121). It moves the documentation of the components to the score/<component>/docs/detailed_design folder as I assumed the components to too small as having the need for an architecture. (https://github.com/eclipse-score/score/blob/main/docs/contribute/general/folder.rst states regarding component architectures: "Component architecture (only if lower level components exist)".) Of course, we could decide differently and move it to the arch folder.

It does not fully fit the demands state in #84.

So, I provide this a draft to share the work so far.

@github-actions

github-actions Bot commented Jul 10, 2026

Copy link
Copy Markdown

License Check Results

🚀 The license check job ran with the Bazel command:

bazel run //:license-check

Status: ⚠️ Needs Review

Click to expand output
[License Check Output]
Extracting Bazel installation...
Starting local Bazel server (8.6.0) and connecting to it...
INFO: Invocation ID: 6e341c4c-de36-4ee6-845a-f6d9bf3e0685
Computing main repo mapping: 
WARNING: /home/runner/work/time/time/MODULE.bazel:13:7: The attribute 'compatibility_level' in module() is a no-op and will be removed in a future Bazel release. Please remove it from your MODULE.bazel file.
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Loading: 
Loading: 3 packages loaded
Loading: 3 packages loaded
    currently loading: 
Loading: 3 packages loaded
    currently loading: 
Loading: 3 packages loaded
    currently loading: 
Loading: 3 packages loaded
    currently loading: 
Loading: 3 packages loaded
    currently loading: 
Analyzing: target //:license-check (4 packages loaded, 0 targets configured)
Analyzing: target //:license-check (4 packages loaded, 0 targets configured)

Analyzing: target //:license-check (34 packages loaded, 10 targets configured)

Analyzing: target //:license-check (89 packages loaded, 10 targets configured)

Analyzing: target //:license-check (139 packages loaded, 835 targets configured)

Analyzing: target //:license-check (153 packages loaded, 3821 targets configured)

Analyzing: target //:license-check (154 packages loaded, 7161 targets configured)

Analyzing: target //:license-check (164 packages loaded, 9276 targets configured)

Analyzing: target //:license-check (165 packages loaded, 9284 targets configured)

Analyzing: target //:license-check (165 packages loaded, 9284 targets configured)

Analyzing: target //:license-check (165 packages loaded, 9284 targets configured)

Analyzing: target //:license-check (168 packages loaded, 11172 targets configured)

Analyzing: target //:license-check (168 packages loaded, 11172 targets configured)

Analyzing: target //:license-check (169 packages loaded, 11296 targets configured)

Analyzing: target //:license-check (169 packages loaded, 11296 targets configured)

INFO: Analyzed target //:license-check (170 packages loaded, 11422 targets configured).
INFO: From Generating Dash formatted dependency file ...:
INFO: Successfully converted 2 packages from Cargo.lock to bazel-out/k8-fastbuild/bin/formatted.txt
[13 / 16] JavaToolchainCompileClasses external/rules_java+/toolchains/platformclasspath_classes; 0s disk-cache, processwrapper-sandbox
[14 / 16] 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: 31.136s, Critical Path: 2.53s
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>]

@BjoernAtBosch BjoernAtBosch force-pushed the bjoernatbosch_restructure_documentation branch from bffb6f4 to bdd0af0 Compare July 10, 2026 14:20
@BjoernAtBosch BjoernAtBosch force-pushed the bjoernatbosch_restructure_documentation branch from bdd0af0 to f7a3b05 Compare July 10, 2026 14:26
@BjoernAtBosch BjoernAtBosch force-pushed the bjoernatbosch_restructure_documentation branch from f7a3b05 to 5f687c4 Compare July 10, 2026 14:37
@BjoernAtBosch BjoernAtBosch force-pushed the bjoernatbosch_restructure_documentation branch from 5f687c4 to 7e93fb3 Compare July 10, 2026 14:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: In Progress

Development

Successfully merging this pull request may close these issues.

1 participant