Prepare for docs migration to separate repository#10407
Open
nopcoder wants to merge 3 commits into
Open
Conversation
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
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
docs.yaml,docs-pr.yaml,check-ui-links.yaml) and related Makefile targets / labeler / gitignore entries as the docs source moves to a separate repositorypush-docs-release.ymlthat, on release or manual dispatch, snapshotscli.md,swagger.yml, andauthorization.ymlintotreeverse/docs-next-lakeFSunderreference-versions/oss/v<MAJOR>.<MINOR>/.github/assets/and note in the README that the docs source has moved out of this repoRelated Issue
None