Skip to content

Template docs: upgrade GVC-creating templates in place without deleting the GVC (5434) - #377

Merged
enk21 merged 4 commits into
mainfrom
docs/5434-keep-gvc
Oct 29, 2026
Merged

enk21 merged 4 commits into
mainfrom
docs/5434-keep-gvc

Conversation

@jacobecox

Copy link
Copy Markdown
Contributor

Docs for templates PR controlplane-com/templates#692 (work item 5434): upgrading a template that used to create its own GVC to its converted version in place, without deleting the GVC, using the new scripts/keep-gvc.py.

Merge after templates #692. These pages link scripts/README.md and the script's raw URL, and both resolve only once #692 is on main.

Per page (11)

Each page gets a new Operations section, "Upgrading in Place from {old}", condensed from the template's README. It covers:

  • the keep-gvc.py steps;
  • the two rules: --gvc must be the GVC the old release created, and the output must show Skipped deletion of …;
  • the values translation and any template-specific steps;
  • what happens afterwards: the GVC is the user's, and uninstall leaves it.

Wherever a page said never to helm upgrade across the change, it now says never a plain helm upgrade and points to the new section. Migrating to a new release stays as the alternative.

  • tidb (1.8.1, staged), etcd-multi-location (1.0.2), nats (2.0.0), pgedge (1.1.1), postgres-multi-location (1.1.0), redis-multi-location (2.2.0)
  • airflow (1.5.0), clickhouse (2.8.0), cockroach (1.5.0), grafana-multi-location (1.1.1), mongodb-cluster (1.1.1)

Checks

  • audit_cli, audit_semantic (against templates jacob/keep-gvc-5434) and audit_skeleton exit 0 on all 11 pages.
  • The render check passed on airflow, tidb and pgedge.
  • mintlify broken-links is clean.
  • Every page's frontmatter parses.
  • Remaining audit WARNs are in text this PR doesn't change (cockroach, grafana-multi-location, redis-multi-location).

🤖 Generated with Claude Code

https://claude.ai/code/session_01WZ5WWhTn9mEkPY7cLt1cr4

@mintlify

mintlify Bot commented Oct 29, 2026 •

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
controlplanecorporation 🟢 Ready View Preview Oct 29, 2026, 10:56 PM

💡 Tip: Enable Automations to automatically generate PRs for you.

@github-actions

Copy link
Copy Markdown

No description provided.

@github-actions

Copy link
Copy Markdown

No description provided.

@enk21
enk21 merged commit eeccbd1 into main Oct 29, 2026
7 checks passed
@enk21
enk21 deleted the docs/5434-keep-gvc branch October 29, 2026 23:37
@github-actions

Copy link
Copy Markdown

No description provided.

This branch was successfully deployed

1 active deployment
staging — 14fe1469 Deployed Oct 29, 2026 by mintlify[bot]
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