Skip to content

Simplify maintaining docs of different projects in sync #196

@sthaha

Description

@sthaha

Problem Statement

The Kepler project maintains three separate GitHub repositories:

  1. kepler – core platform code and documentation
  2. kepler-operator – operator‑specific docs
  3. kepler-docs – a “master” repo that currently aggregates all user/project documentation

Because the core and operator repos are not linked to kepler-docs, any change in their respective doc directories requires manual copying or duplicate updates, which is error‑prone and time‑consuming.

To streamline documentation maintenance and ensure consistency across all docs, we propose adding Git submodules for the kepler and kepler-operator repositories inside the kepler-docs repo. This will:

  • Provide a single source of truth for each set of docs
  • Enable automatic updates via git submodule update --remote
  • Simplify contributors’ workflow (they only need to pull the top‑level repo)

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions