-
Notifications
You must be signed in to change notification settings - Fork 39
Open
Description
After the docs-as-code is functional in the baseslibs repo, the whole content of https://github.com/eclipse-score/score/tree/main/docs/modules/baselibs should be migrated to the baseslibs repo.
The approach for the cross-repo traceability in docs: https://eclipse-score.github.io/score/main/design_decisions/DR-004-infra.html
Idea how to avoid need id conflict between score and baselibs repo during migration:
- PR1: There is PR in score repo removing baselibs module docs.
- PR2: baselibs depends on score module in bazel with a
git_overridepointing to that PR. - Merge PR2.
- At this point, the PR1. cannot be merged yet due to references to baselibs elements. Example: https://github.com/eclipse-score/score/blob/main/docs/features/communication/docs/architecture/index.rst?plain=1#L52
- How to merge PR1? Options:
- Introduce a cyclic dependency (maybe) in score repo???
- Clean up feature architecture of most of features that it doesn't reference the modules
- Also (needs to be done anyways): move all modules to corresponding repos.
Another idea how to avoid issues with PR1:
- Rename baselibs needs id to avoid conflicts
- Do the move
- Do the cleanup is the score repo (i.e. move other module docs to their repos, cleanup feature architecture)
- Rename needs ids back.
Acceptance criteria
- The Baselibs module documentation is migrated to https://github.com/eclipse-score/baselibs with preserving git history.
- Issues with linking to architecture elements is resolved in score repo
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
No labels
Type
Projects
Status
Backlog
Status
Backlog