Skip to content

docs: add docs_as_code docs bundles for components - #179

Merged
mariuswbr merged 8 commits into
eclipse-score:mainfrom
etas-contrib:add-docs-bundles-support
Aug 19, 2026
Merged

docs: add docs_as_code docs bundles for components#179
mariuswbr merged 8 commits into
eclipse-score:mainfrom
etas-contrib:add-docs-bundles-support

Conversation

@ryan-steel

@ryan-steel ryan-steel commented Aug 18, 2026

Copy link
Copy Markdown
Contributor

This is split out from #148 because there are multiple PRs that rely on it now.

Adds docs_as_code bundles.
Required updates to docs files for build to run (these files weren't touched by docs build before).
Included score_platform needs for linkage to feature.

@ryan-steel
ryan-steel deployed to workflow-approval August 18, 2026 14:56 — with GitHub Actions Active
@ryan-steel
ryan-steel deployed to workflow-approval August 18, 2026 14:56 — with GitHub Actions Active
@ryan-steel
ryan-steel marked this pull request as ready for review August 18, 2026 14:57
@github-actions

github-actions Bot commented Aug 18, 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: 6407caa2-9c58-4819-b363-2511ab24b83f
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)
Analyzing: target //:license-check (4 packages loaded, 0 targets configured)
Analyzing: target //:license-check (4 packages loaded, 0 targets configured)

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

Analyzing: target //:license-check (108 packages loaded, 225 targets configured)

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

Analyzing: target //:license-check (159 packages loaded, 6206 targets configured)

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

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

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

Analyzing: target //:license-check (167 packages loaded, 8142 targets configured)

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

Analyzing: target //:license-check (171 packages loaded, 11350 targets configured)

Analyzing: target //:license-check (171 packages loaded, 11350 targets configured)

Analyzing: target //:license-check (171 packages loaded, 11350 targets configured)

Analyzing: target //:license-check (172 packages loaded, 11476 targets configured)

INFO: Analyzed target //:license-check (172 packages loaded, 11476 targets configured).
[12 / 16] JavaToolchainCompileClasses external/rules_java+/toolchains/platformclasspath_classes; 0s disk-cache, processwrapper-sandbox ... (2 actions running)
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
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.377s, Critical Path: 2.44s
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

Copy link
Copy Markdown

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

@ryan-steel
ryan-steel deployed to workflow-approval August 19, 2026 09:14 — with GitHub Actions Active
@ryan-steel
ryan-steel deployed to workflow-approval August 19, 2026 09:14 — with GitHub Actions Active
Comment thread docs/module/index.rst

@BjoernAtBosch BjoernAtBosch left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM

@mariuswbr mariuswbr left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Took me a while to get the docs_bundle concept, but I have to admit... it is pretty neat. 👍
Looks fine. Just one proposal to not mixup names, if you agree. If not, fine to merge otherwise too.

Comment thread docs/module/index.rst
@mariuswbr
mariuswbr merged commit bf3bad6 into eclipse-score:main Aug 19, 2026
18 of 20 checks passed
@github-project-automation github-project-automation Bot moved this from In Progress to Done in TIM - Time FT Aug 19, 2026
@ryan-steel
ryan-steel deleted the add-docs-bundles-support branch August 19, 2026 15:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

4 participants