Skip to content

Prepare for docs migration to separate repository#10407

Open
nopcoder wants to merge 3 commits into
masterfrom
remove-docs-workflows
Open

Prepare for docs migration to separate repository#10407
nopcoder wants to merge 3 commits into
masterfrom
remove-docs-workflows

Conversation

@nopcoder
Copy link
Copy Markdown
Contributor

@nopcoder nopcoder commented May 14, 2026

Summary

  • Remove docs build/publish workflows (docs.yaml, docs-pr.yaml, check-ui-links.yaml) and related Makefile targets / labeler / gitignore entries as the docs source moves to a separate repository
  • Add push-docs-release.yml that, on release or manual dispatch, snapshots cli.md, swagger.yml, and authorization.yml into treeverse/docs-next-lakeFS under reference-versions/oss/v<MAJOR>.<MINOR>/
  • Relocate the README logo to .github/assets/ and note in the README that the docs source has moved out of this repo

Related Issue

None

The documentation source is moving out of this repo to a separate
repository (TBD). This change removes the workflows and tooling that
treat `docs/` as a publishable source of truth, and adds a new
release-time workflow that pushes generated CLI/API/auth reference
files to `treeverse/docs-next-lakeFS`.

- Delete docs.yaml, docs-pr.yaml, check-ui-links.yaml workflows
- Add push-docs-release.yml: on release / manual dispatch, snapshot
  cli.md, swagger.yml, authorization.yml into docs-next-lakeFS under
  reference-versions/oss/v<MAJOR>.<MINOR>/
- Drop docs-serve, gen-docs, validate-reference Makefile targets and
  remove them from the gen / checks-validator aggregates
- Drop the docs/** labeler rule and /docs/* .gitignore entries
- Relocate the README logo from docs/src/assets/img/ to .github/assets/
- Note in README that docs source has moved out of this repo
@nopcoder nopcoder added exclude-changelog PR description should not be included in next release changelog minor-change Used for PRs that don't require issue attached mostly-ai labels May 14, 2026
@nopcoder nopcoder self-assigned this May 14, 2026
@github-actions github-actions Bot added infrastructure build, deploy and release processes area/ci labels May 14, 2026
nopcoder added 2 commits May 14, 2026 17:18
Reduce workflow-specific configuration and remove unnecessary generation steps to streamline release docs publishing.
Clarifies the current documentation source of truth by dropping stale guidance.
@nopcoder nopcoder requested a review from Annaseli May 14, 2026 14:20
@nopcoder nopcoder mentioned this pull request May 16, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/ci exclude-changelog PR description should not be included in next release changelog infrastructure build, deploy and release processes minor-change Used for PRs that don't require issue attached mostly-ai

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant