Refactor: Align with docs-as-code 2.0.0 #1981
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Remove prefixes for mega-build (DR-004-Infra) and align with docs-as-code 2.0.0 to enable single documentation mega-build where all repositories can be built together without prefix conflicts. Changes: - Remove project_prefix "S-CORE_" from docs/conf.py - Remove PROCESS_ prefix from all external need references - Fix incorrect need ID: wp__platform_sw_aou -> wp__requirements_sw_platform_aou Rationale: docs-as-code 2.0.0 removed module prefixes to support the mega-build approach where documentation from all repositories is built in a single Sphinx instance. Requirement IDs remain globally unique through built-in namespacing, eliminating the need for repository-specific prefixes. The mega-build also improves validation: the incorrect reference to wp__platform_sw_aou was only detected after removing prefixes, demonstrating better error detection in the unified build. Related: - eclipse-score/docs-as-code#293 - https://eclipse-score.github.io/score/main/design_decisions/DR-004-infra.html
guejan
requested review from
a team,
AlexanderLanin,
FScholPer,
HartmannNico,
PhilipPartsch,
antonkri,
aschemmel-tech,
dcalavrezo-qorix,
grandyholger,
johannes-esr,
masc2023,
pahmann,
qor-lb,
skappel29 and
thilo-schmitt
as code owners
|
|
a-zw
approved these changes
Nov 10, 2025
| :security: YES | ||
| :safety: ASIL_B | ||
| :realizes: PROCESS_wp__platform_sw_aou | ||
| :realizes: wp__requirements_sw_platform_aou |
Contributor
There was a problem hiding this comment.
Just to mark the change, this was the id change. 👍
a-zw
suggested changes
Nov 10, 2025
MODULE.bazel
Outdated
|
|
||
| module( | ||
| name = "score_platform", | ||
| version = "0.4.0", |
Contributor
There was a problem hiding this comment.
Suggested change
| version = "0.4.1", |
We need to bump the version, so other modules can start using this "updated to docs_as_code 2.0.0" version.
Contributor
|
Is this something we need tomorrow for the BIG release of v0.5 alpha? |
Member
yes, we want to integrate a cross repo docs build into release 0.5 |
|
The created documentation from the pull request is available at: docu-html |
AlexanderLanin
approved these changes
Nov 10, 2025
masc2023
approved these changes
Nov 10, 2025
a-zw
approved these changes
Nov 11, 2025
FScholPer
approved these changes
Nov 11, 2025
thilo-schmitt
approved these changes
Nov 11, 2025
Member
|
Thanks @masc2023 @FScholPer @thilo-schmitt! And thank you for merging quickly @FScholPer! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Remove prefixes for mega-build (DR-004-Infra) and
align with docs-as-code 2.0.0 to enable single documentation mega-build where all repositories can be built together without prefix conflicts.
Changes:
wp__requirements_sw_platform_aou
Rationale:
docs-as-code 2.0.0 removed module prefixes to support the mega-build approach where documentation from all repositories is built in a single Sphinx instance. Requirement IDs remain globally unique through built-in namespacing,
eliminating the need for repository-specific prefixes.
The mega-build also improves validation: the incorrect reference to wp__platform_sw_aou was only detected after removing prefixes, demonstrating better error detection in the unified build.
Related: