Skip to content

chore: move docs - #353

Merged
umaucher merged 4 commits into
eclipse-score:mainfrom
etas-contrib:mounts
Aug 11, 2026
Merged

chore: move docs#353
umaucher merged 4 commits into
eclipse-score:mainfrom
etas-contrib:mounts

Conversation

@AlexanderLanin

@AlexanderLanin AlexanderLanin commented Jul 28, 2026

Copy link
Copy Markdown
Member

This pull request introduces a new structure for component documentation and improves the way documentation bundles are built and organized. The most important changes include the addition of new docs_bundle build targets for the KVS and JSON components, a new centralized component documentation index, and updates to documentation references and paths to match the new organization.

Documentation build and structure improvements:

  • Added docs_bundle build targets for KVS (kvs_docs) and JSON (json_docs) components in score/BUILD, specifying their source directories and code targets for more modular documentation builds.
  • Updated the main BUILD file to include these new documentation bundles in the docs rule, mounting them at components/kvs and components/json respectively.

Documentation organization and navigation:

  • Added a new docs/components/index.rst file serving as a central index for component documentation, including a needtable overview of all "score" documents.
  • Updated docs/index.rst to reference the new component documentation index and adjusted paths for module/feature documentation to reflect the new directory structure. [1] [2]
  • Updated internal references and paths in component documentation files (e.g., score/kvs/docs/index.rst and score/json/docs/index.rst) to match the new organization, removing redundant or outdated toctree entries. [1] [2]

These changes make the documentation more modular, easier to navigate, and better organized for both maintainers and users.

@github-actions

github-actions Bot commented Jul 28, 2026

Copy link
Copy Markdown

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.6.0) and connecting to it...
INFO: Invocation ID: 27c51bfa-dabc-4430-8a79-b60ebd34a14a
Computing main repo mapping: 
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: 
Analyzing: target //:license-check (4 packages loaded, 0 targets configured)
Analyzing: target //:license-check (4 packages loaded, 0 targets configured)

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

Analyzing: target //:license-check (95 packages loaded, 25 targets configured)

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

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

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

Analyzing: target //:license-check (148 packages loaded, 5385 targets configured)

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

Analyzing: target //:license-check (161 packages loaded, 8133 targets configured)

Analyzing: target //:license-check (161 packages loaded, 8133 targets configured)

Analyzing: target //:license-check (161 packages loaded, 8133 targets configured)

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

INFO: Analyzed target //:license-check (166 packages loaded, 10271 targets configured).
[8 / 17] Creating runfiles tree bazel-out/k8-opt-exec-ST-d57f47055a04/bin/external/score_tooling+/dash/tool/formatters/dash_format_converter.runfiles [for tool]; 0s local ... (2 actions, 1 running)
INFO: From Generating Dash formatted dependency file ...:
INFO: Successfully converted 66 packages from Cargo.lock to bazel-out/k8-fastbuild/bin/formatted.txt
[14 / 17] JavaToolchainCompileClasses external/rules_java+/toolchains/platformclasspath_classes; 0s disk-cache, processwrapper-sandbox
[15 / 17] 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: 30.361s, Critical Path: 2.36s
INFO: 17 processes: 12 internal, 4 processwrapper-sandbox, 1 worker.
INFO: Build completed successfully, 17 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>]

@AlexanderLanin
AlexanderLanin deployed to workflow-approval August 11, 2026 09:28 — with GitHub Actions Active
@AlexanderLanin
AlexanderLanin deployed to workflow-approval August 11, 2026 09:28 — with GitHub Actions Active
@github-actions

Copy link
Copy Markdown

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

@AlexanderLanin
AlexanderLanin marked this pull request as ready for review August 11, 2026 09:38
@AlexanderLanin
AlexanderLanin deployed to workflow-approval August 11, 2026 09:55 — with GitHub Actions Active
@AlexanderLanin
AlexanderLanin deployed to workflow-approval August 11, 2026 09:55 — with GitHub Actions Active
@umaucher
umaucher merged commit 8d5d708 into eclipse-score:main Aug 11, 2026
21 of 22 checks passed
@umaucher

Copy link
Copy Markdown
Contributor

"fixed" gitlint issue in "squash and merge"

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.

docs() target in root BUILD references dev_dependency bazel_dep, breaks when persistency is consumed as a transitive module

2 participants