Skip to content

docs(doc-1574, doc-1575): align secrets and connect-cluster docs with current platform UI#2334

Open
djwfyi wants to merge 5 commits into
mainfrom
DOC-1574/platform-ui-alignment
Open

docs(doc-1574, doc-1575): align secrets and connect-cluster docs with current platform UI#2334
djwfyi wants to merge 5 commits into
mainfrom
DOC-1574/platform-ui-alignment

Conversation

@djwfyi

@djwfyi djwfyi commented Jun 25, 2026 •
edited
Loading

Copy link
Copy Markdown
Collaborator

Content Description

Updates secrets and connect-cluster docs to match the current Platform UI navigation, labels, and CLI commands. Verified against loft-enterprise UI source and vcluster CLI help output.

Preview Link

Internal Reference

Closes DOC-1574
Closes DOC-1575
Closes DOC-1579

AI review: mention @claude in a comment to request a review or changes. See CONTRIBUTING.md for available commands.

FORK LIMITATION: @claude does not work on pull requests opened from forks. GitHub Actions cannot access the required secrets for fork-originated PRs. To use AI review, push your branch directly to this repository.

@netlify /docs

@djwfyi @claude
docs(doc-1574,doc-1575): align secrets and connect-cluster docs with …
2b1c547 
…current platform ui

- secrets: nav routes updated to Access & Secrets > Global Secrets
- secrets: project secrets tab renamed from "Project Secrets" to "Secrets"
- secrets: "Management Access" replaces stale "Access"/"Permissions" tab labels
- secrets: global-sync form labels match current radio/select UI text
- secrets: fix garbled duplicate namespace step in global create flow
- secrets: fix vcluster cli commands in retrieve page (get secret / list secrets)
- connect-cluster: nav updated to Infrastructure > Control Plane Clusters
- connect-cluster: button renamed from "Connect Cluster via CLI" to "Connect Cluster"
- vale: fix all pre-existing warnings in touched files

Closes DOC-1574
Closes DOC-1575

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@djwfyi djwfyi requested a review from a team as a code owner June 25, 2026 16:51
@netlify

netlify Bot commented Jun 25, 2026 •
edited
Loading

Copy link
Copy Markdown

✅ Deploy Preview for vcluster-docs-site ready!

Name Link
🔨 Latest commit 5deabc2
🔍 Latest deploy log https://app.netlify.com/projects/vcluster-docs-site/deploys/6a3eaee840e70d00086022a0
😎 Deploy Preview https://deploy-preview-2334--vcluster-docs-site.netlify.app/docs
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@github-actions

github-actions Bot commented Jun 25, 2026

Copy link
Copy Markdown
Contributor

DOC-1574: Fix Platform secrets docs to match current UI (global under Access & Secrets, project renamed to "Secrets")

@github-actions

github-actions Bot commented Jun 25, 2026

Copy link
Copy Markdown
Contributor

DOC-1575: Fix "Connect a Cluster" docs — nav moved to Infrastructure > Control Plane Clusters, button renamed

@djwfyi djwfyi self-assigned this Jun 25, 2026
djwfyi and others added 2 commits June 25, 2026 13:06
@djwfyi @claude
docs(doc-1574,doc-1575): simplify flow step wording to match connect-…
c3a9593 
…ui style

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@djwfyi @claude
docs(doc-1574,doc-1575): polish prose, headings, and structure across…
546e953 
… secrets pages

- fold admonitions into prose throughout
- rename section headings to lead with the distinguishing action
- add when-to-use context to retrieve page
- link global create page to project create page
- tighten intro copy on project create page

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@djwfyi djwfyi requested a review from DadaGore June 25, 2026 17:38
@DadaGore

DadaGore commented Jun 26, 2026

Copy link
Copy Markdown
Contributor

Below two pages will aslo need similar path updates. Current changes are good to go.
https://deploy-preview-2334--vcluster-docs-site.netlify.app/docs/platform/next/administer/clusters/cluster-roles and https://deploy-preview-2334--vcluster-docs-site.netlify.app/docs/platform/next/administer/clusters/advanced/agent-config

@djwfyi

djwfyi commented Jun 26, 2026

Copy link
Copy Markdown
Collaborator Author

The two files flagged during review (administer/clusters/cluster-roles.mdx and administer/clusters/advanced/agent-config.mdx) have been fixed in this PR.

While fixing those, I ran npm run report-platform-ui-drift — a script that compares UI tokens and prose in the platform docs against the loft-enterprise UI source. It flagged a broader set of files carrying the same stale patterns. These should be tracked as follow-up work.

Files with the same nav/sheet/dropdown pattern as the two just fixed:

  • administer/clusters/advanced/ingress-suffix.mdx — drop down arrow, drawer, configuration pane
  • configure/agent-settings/agent-upgrade.mdx — drop down arrow, drawer, checkbox, configuration pane
  • configure/agent-settings/customization.mdx — drop down arrow, drawer, configuration pane, textarea
  • administer/users-permissions/permissions/cluster.mdx — drawer, configuration pane, drop down menu (×3 steps)
  • administer/users-permissions/permissions/project.mdx — left sidebar, dropdown menu (×5 steps)

Files with widespread "left menu" prose:

  • administer/templates/create-templates.mdx (4 occurrences)
  • administer/templates/versioning.mdx (6 occurrences)
  • administer/users-permissions/managing-users/impersonate.mdx (5 occurrences)
  • Various use-platform/apps/ files

Unmatched UI tokens that look like genuine drift:

  • <Button>Create Space Template</Button> — UI now says "Create Namespace Template"
  • <Button>Deploy App</Button> — not found in current UI source
  • <NavStep>Allowed Templates</NavStep> / Allowed Clusters / Configure Project Quotas — project form sections renamed to "Template Options", "Control Plane Clusters", "Quotas"

The drift report is at scripts/report-platform-ui-drift.js. A skill at .claude/skills/platform-ui-drift/SKILL.md documents how to interpret and act on the output.

djwfyi and others added 2 commits June 26, 2026 12:52
@djwfyi @claude
docs(doc-1574): fix platform ui drift across 55 files
63718ca 
corrects button labels, field labels, nav steps, and ui instruction
phrases to match current loft-enterprise ui source. adds
report-platform-ui-drift.js script and platform-ui-drift skill to
detect future drift. reduces unmatched tokens from 32 to 4 (the 4
remaining require live ui access to verify) and clears all 130
instruction phrase findings.

Closes DOC-1574

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@djwfyi @claude
docs(doc-1574): update platform-ui-drift skill with known expected to…
5deabc2 
…kens and current baseline

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@github-actions

github-actions Bot commented Jun 26, 2026

Copy link
Copy Markdown
Contributor

DOC-1579: Add automated checks for Platform UI docs drift

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@DadaGore DadaGore Awaiting requested review from DadaGore

At least 1 approving review is required to merge this pull request.

Assignees

@djwfyi djwfyi

Labels

backport-v4.10.0

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@djwfyi @DadaGore