Skip to content

Migrate module documentation to eclipse-score/baselibs #43

@4og

Description

@4og

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_override pointing 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:

  1. Rename baselibs needs id to avoid conflicts
  2. Do the move
  3. Do the cleanup is the score repo (i.e. move other module docs to their repos, cleanup feature architecture)
  4. Rename needs ids back.

Acceptance criteria

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    Projects

    Status

    Backlog

    Status

    Backlog

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions