Skip to content

docs: move published docs to volcano-docs - #489

Merged
swkeever merged 1 commit into
mainfrom
skeever/decouple-docs
Nov 13, 2026
Merged

swkeever merged 1 commit into
mainfrom
skeever/decouple-docs

Conversation

@swkeever

@swkeever swkeever commented Nov 13, 2026 •

Copy link
Copy Markdown
Collaborator

Why

Kong/volcano-docs becomes the single source of truth for all public Volcano docs. The daily cross-repo sync that copied this repo's docs/ into volcano-docs content/cli is being removed, so this repository stops carrying published docs. Agents and contributors now write CLI docs directly in volcano-docs with a companion PR.

What changed

  • Remove docs/ (27 pages). volcano-docs content/cli owns the published copy.
  • Remove .github/workflows/lint-docs.yml, which only ran the volcano-docs reusable lint on docs/**. It is not a required check.
  • AGENTS.md: replace the "update docs/ in the same PR" rule with: public CLI docs live in Kong/volcano-docs under content/cli; a user-facing change opens a companion PR there. The guidance to keep maintainer material next to the code stays.
  • README.md and CONTRIBUTING.md: point doc links at https://docs.volcano.dev/cli. The README's "CLI operations overview" link (docs/cli/overview.md) is dropped because that page never existed.
  • internal/docs/source.go: comment now says the CLI docs live (not are synced) under content/cli. No behavior change: volcano docs already reads Kong/volcano-docs content/ at runtime.

No test in this repo reads docs/, and nothing generates docs/ from code.

docs/ vs volcano-docs content/cli

Every CLI docs change is now in volcano-docs content/cli:

Merge order

Kong/volcano-docs#170, which removes the sync, has merged, so this can merge now. A docs/ change that lands on main before this PR merges must be ported to volcano-docs first.

Testing

  • go build ./...: passed
  • go test ./...: passed
  • go tool golangci-lint run ./internal/docs/...: 0 issues
  • Checked the new links resolve on https://docs.volcano.dev (/cli, /cli/installation, /cli/authentication, /cli/deploy, /cli/project-configuration, /cli/docs-search return 200; an unknown path returns 404).

Related

🤖 Generated with Claude Code

@github-actions

github-actions Bot commented Nov 13, 2026 •

Copy link
Copy Markdown

AI review: no P0-P2 findings

Reviewed 5b4d02b. Run log

This PR deletes the published docs/ tree (27 pages) and lint-docs.yml, which only linted docs/**. It points the README and CONTRIBUTING doc links at docs.volcano.dev/cli, replaces the AGENTS.md rule to update docs/ with a rule to open a companion PR in Kong/volcano-docs, and rewords one comment in internal/docs/source.go. No Go code, embed, workflow, script, release config, or package manifest in the head reads docs/, and volcano docs already fetches Kong/volcano-docs at runtime. The last review's finding was that #365 and #490 were missing from the list of pages to port. The description now covers both (volcano-docs#170 and #175), so that finding no longer applies. The remaining risk is the hand-off to volcano-docs, which this review can't check.

Not checked: The AI review read the diff, the code, and the PR's text; it ran no tests or builds and read nothing outside this repository.

Human review: not needed

@github-actions
github-actions Bot requested a review from tkkhq November 13, 2026 16:27

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🔵 Needs a closer look

Deleting docs/ requires maintainer coordination to first merge the still-open Kong/volcano-docs#170 with sync removal and a final snapshot preserving the five unsynced CLI pages.

No open issues 🎉

What changed in this PR

Makes Kong/volcano-docs the sole source for public CLI documentation, removing the local published copies without changing CLI runtime behavior.

Changes:

  • Removes 27 documentation pages and their lint workflow.
  • Updates contributor guidance to require linked companion documentation PRs and points README links to the published site.
  • Clarifies the documentation-source comment; volcano docs continues reading the same remote source.

The migration is coordinated with upstream sync removal and preservation of the five unsynced documentation updates identified in the PR description.

File Description
README.md Links to published CLI docs; drops a nonexistent page link.
internal/​docs/​source.go Updates a source-location comment only.
docs/​variables.md Removes local variables guide.
docs/​telemetry.md Removes local telemetry guide.
docs/​storage.md Removes local storage guide.
docs/​share.md Removes local sharing and forking guide.
docs/​setup.md Removes local agent setup guide.
docs/​scripting.md Removes local scripting guide.
docs/​sandboxes.md Removes local sandbox guide.
docs/​README.md Removes local CLI overview.
docs/​project-configuration.md Removes local configuration reference.
docs/​notifications.md Removes local notifications guide.
docs/​logs.md Removes local logs guide.
docs/​lavaflow.md Removes local LavaFlow guide.
docs/​installation.md Removes local installation guide.
docs/​git.md Removes local Git connection guide.
docs/​functions.md Removes local functions guide.
docs/​frontends.md Removes local frontends guide.
docs/​feedback.md Removes local feedback guide.
docs/​durable-functions.md Removes local durable functions guide.
docs/​domains.md Removes local domain verification guide.
docs/​docs-search.md Removes local documentation search guide.
docs/​deployments.md Removes local deployment history guide.
docs/​deploy.md Removes local project deployment guide.
docs/​databases.md Removes local databases guide.
docs/​connect.md Removes local directory connection guide.
docs/​authentication.md Removes local authentication guide.
docs/​agent-detection.md Removes local agent detection guide.
docs/​access-tokens.md Removes local access token guide.
CONTRIBUTING.md Points installation guidance to the published site.
AGENTS.md Replaces local docs updates with linked companion PRs.
.github/​workflows/​lint-docs.yml Removes linting for the deleted documentation directory.

Review effort: Balanced

@swkeever
swkeever force-pushed the skeever/decouple-docs branch from 2efda9f to 087bb6d Compare November 13, 2026 16:28
@swkeever
swkeever enabled auto-merge November 13, 2026 16:44
@swkeever
swkeever force-pushed the skeever/decouple-docs branch from 087bb6d to 5cd0bb5 Compare November 13, 2026 17:18
@swkeever swkeever closed this Nov 13, 2026
auto-merge was automatically disabled November 13, 2026 17:26

Pull request was closed

@swkeever swkeever reopened this Nov 13, 2026
@swkeever
swkeever enabled auto-merge November 13, 2026 17:26
Kong/volcano-docs is now the single source of truth for the public CLI docs
under content/cli. Remove docs/ and the shared docs lint workflow, point the
README and CONTRIBUTING links at docs.volcano.dev/cli, and replace the
'update docs/ in the same PR' rule with a companion-PR rule.
@swkeever
swkeever force-pushed the skeever/decouple-docs branch from 5cd0bb5 to 5b4d02b Compare November 13, 2026 17:28
@swkeever
swkeever added this pull request to the merge queue Nov 13, 2026
Merged via the queue into main with commit 21396d0 Nov 13, 2026
17 checks passed
@swkeever
swkeever deleted the skeever/decouple-docs branch November 13, 2026 17:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants