Skip to content

docs: split towards multiple docs_bundles - #443

Merged
MaciejKaszynski merged 4 commits into
eclipse-score:mainfrom
etas-contrib:update-metamodel
Aug 10, 2026
Merged

MaciejKaszynski merged 4 commits into
eclipse-score:mainfrom
etas-contrib:update-metamodel

Conversation

@AlexanderLanin

@AlexanderLanin AlexanderLanin commented Aug 10, 2026

Copy link
Copy Markdown
Member

This pull request introduces significant improvements to the documentation build system by modularizing documentation bundles for components and subcomponents, updating Sphinx configuration, and improving navigation structure. The changes make it easier to manage, build, and browse documentation for the launch_manager and health_monitor components and their subcomponents.

Documentation Build System Improvements:

  • Introduced docs_bundle Bazel targets for both score/launch_manager and score/health_monitor, enabling modular, component-specific documentation builds. Subcomponent documentation is now bundled and mountable at specified paths for better organization.
  • Updated the main BUILD file to aggregate component documentation using the new bundle system and added project metadata for improved documentation context.
  • Refactored documentation indices to use new components/index.rst and subcomponents/index.rst files, allowing dynamic population of navigation trees via the docs_bundle system. This replaces hardcoded paths with a more maintainable structure.
  • Removed the custom conf.py Sphinx configuration in favor of Bazel-driven configuration, simplifying the build process and reducing maintenance overhead.
  • Updated filegroup visibility for configuration schema files to be public, ensuring full documentation builds have access to necessary data.

These changes collectively modernize and modularize the documentation workflow, making it more scalable and maintainable as the project grows.

@github-actions

github-actions Bot commented Aug 10, 2026

Copy link
Copy Markdown
Contributor

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: e17ab229-4418-4418-9fed-e29789ec67ff
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: 
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 (35 packages loaded, 10 targets configured)

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

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

Analyzing: target //:license-check (150 packages loaded, 3143 targets configured)

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

Analyzing: target //:license-check (170 packages loaded, 9397 targets configured)

Analyzing: target //:license-check (170 packages loaded, 9397 targets configured)

Analyzing: target //:license-check (170 packages loaded, 9397 targets configured)

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

INFO: Analyzed target //:license-check (175 packages loaded, 11535 targets configured).
[12 / 16] Generating Dash formatted dependency file ...; 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: 27.388s, Critical Path: 2.47s
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>]

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Splits monolithic documentation into composable component and subcomponent bundles.

Changes:

  • Adds documentation bundles for Launch Manager, Lifecycle Client, and Health Monitor.
  • Introduces bundle mount-point indexes and updates Sphinx references.
  • Moves Sphinx configuration into the Bazel documentation rule.

Reviewed changes

Copilot reviewed 12 out of 13 changed files in this pull request and generated no comments.

Show a summary per file
File Description
BUILD Configures root documentation and component bundles.
conf.py Removes obsolete standalone Sphinx configuration.
docs/index.rst Updates paths for the new source root and bundle index.
docs/components/index.rst Adds the component bundle mount point.
docs/manuals/user_manual.rst Uses the release-notes reference label.
docs/release/index.rst Defines the release-notes label.
score/health_monitor/BUILD Defines the Health Monitor documentation bundle.
score/launch_manager/BUILD Defines the Launch Manager bundle and nested client bundle.
score/launch_manager/docs/index.rst Routes subcomponent documentation through its mount point.
score/launch_manager/docs/subcomponents/index.rst Adds the subcomponent bundle mount point.
score/launch_manager/src/lifecycle_client/BUILD Defines the Lifecycle Client documentation bundle.
score/launch_manager/src/daemon/src/configuration/README.rst Documents configuration schema usage and structure.
score/launch_manager/src/daemon/src/configuration/config_schema/BUILD Exposes schema files to documentation bundles.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

@github-actions

Copy link
Copy Markdown
Contributor

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

@MaciejKaszynski MaciejKaszynski 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.

Please could you also update the description of the PR to be more descriptive of the changes.

Comment thread conf.py Outdated
@MaciejKaszynski
MaciejKaszynski merged commit 93f9feb into eclipse-score:main Aug 10, 2026
15 of 18 checks passed
@github-project-automation github-project-automation Bot moved this from Backlog to Done in LCM - Lifecycle & Health FT Aug 10, 2026
Comment thread docs/index.rst

score/launch_manager/docs/index
score/health_monitor/docs/index
components/index

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

This changes URLs but I guess that is ok for lifecycle as it is unlikely there are many links floating around.

@AlexanderLanin
AlexanderLanin deleted the update-metamodel branch August 10, 2026 14:39
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