Skip to content

Decide separate repository strategy for operations documents #47

Description

@alexeygrigorev

Goal

Decide and implement the repository boundary for DataOps operational documents.

The current v1 merge keeps app code and imported content/ in DataTalksClub/dataops. We likely want operational documents in a separate GitHub repository so they can be edited, reviewed, permissioned, and synchronized independently from portal code.

Questions To Decide

  • Should the docs repo be public or private?
  • Should the docs repo contain only content/, or also document templates, screenshots/images, process metadata, and podcast knowledge documents?
  • What should the repo be named? Candidate: DataTalksClub/dataops-docs.
  • Should the portal read docs directly from the docs repo at runtime, or should CI mirror docs into the app artifact?
  • How should edits from the portal commit back to the docs repo?
  • Should issues for document work live in dataops, the docs repo, or both with cross-links?
  • What branch and review rules should apply to docs edits?

Candidate Direction

  • Keep DataTalksClub/dataops for application code, task engine integration, assistants, infra templates, CI/CD, and product planning.
  • Create a separate docs/content repo for operational documents and assets.
  • Configure the Lambda app with GITHUB_OWNER, GITHUB_REPO, and GITHUB_BRANCH pointing to the docs repo for content reads/writes.
  • Keep portal deploys code-driven, and make docs repo pushes trigger a cache refresh and content validation workflow.

Acceptance Criteria

  • ADR documents the repo boundary and chosen repo name.
  • Migration plan lists files/directories to move from dataops to the docs repo.
  • Runtime configuration changes are identified for Lambda content reads and portal edits.
  • CI plan covers docs validation and deployed cache refresh from the docs repo.
  • Permission model is documented for app deployers vs document editors.

Metadata

Metadata

Assignees

No one assigned

    Labels

    P0Must havedocsDocumentation or process docs workmigrationImport or migration workprocess-docsSOPs, templates, references, playbooks

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions