Skip to content

Prepare for docs migration to separate repository - #10407

Merged
nopcoder merged 4 commits into
masterfrom
remove-docs-workflows
May 18, 2026
Merged

Prepare for docs migration to separate repository#10407
nopcoder merged 4 commits into
masterfrom
remove-docs-workflows

Conversation

@nopcoder

@nopcoder nopcoder commented May 14, 2026

Copy link
Copy Markdown
Contributor

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
@nopcoder
nopcoder requested a review from a team May 17, 2026 10:35

@Annaseli Annaseli left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. release: [published] fires for prereleases too. a prerelease publish overwrites stable v1.83/ and re-points LATEST to the prerelease.

  2. Where does check-ui-links live post-migration?

  3. Old docs.yaml Slack-alerted on failure; this doesn't.

  4. Generation of cli.md could exit 0 with an empty/partial file, do we want to check it?

  5. Does TREEVERSE_CI_TOKEN has contents: write on docs-next-lakeFS (was scoped to docs-lakeFS-community)?

@nopcoder

nopcoder commented May 18, 2026

Copy link
Copy Markdown
Contributor Author
  1. release: [published] fires for prereleases too. a prerelease publish overwrites stable v1.83/ and re-points LATEST to the prerelease.
    I kept the current workflow (docs) logic.
  1. Where does check-ui-links live post-migration?
    Separation of docs into a different site will not enable us to check the links as part of the same PR timeline. Will open an issue to perform a check during release as information step to identify if there are missing or pending changes in the docs that are missing.
    Add check-ui-links workflow to verify docs.lakefs.io links on release #10412
  1. Old docs.yaml Slack-alerted on failure; this doesn't.
    relevant to docs-next repository - will open an issue there.
  1. Generation of cli.md could exit 0 with an empty/partial file, do we want to check it?
    If the step does not with non zero exit code, this is a bug in the lakectl docs gen. I've testing by trying to write the docs to a read-only location and it fails with non-zero exit code.
  1. Does TREEVERSE_CI_TOKEN has contents: write on docs-next-lakeFS (was scoped to docs-lakeFS-community)?
    yes

@github-actions github-actions Bot added docs Improvements or additions to documentation dependencies Pull requests that update a dependency file labels May 18, 2026
@nopcoder
nopcoder enabled auto-merge (squash) May 18, 2026 09:12
@nopcoder
nopcoder merged commit e13f3a0 into master May 18, 2026
56 checks passed
@nopcoder
nopcoder deleted the remove-docs-workflows branch May 18, 2026 09:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/ci dependencies Pull requests that update a dependency file docs Improvements or additions to documentation 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.

2 participants