Rework cloud upgrades page for clarity#288
Conversation
Split the Maintenance and upgrades page into two clearly separated top-level sections — TimescaleDB upgrades and PostgreSQL upgrades — so readers can find what applies to them without conflating products. Consolidate scattered downtime guidance into a single subsection, add a "Check your current versions" section pointing to the Service Upgrades panel in Console, and replace single-theme screenshots with ThemeImage pairs.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
| the replica. | ||
| ### Non-critical upgrades | ||
|
|
||
| Non-critical upgrades — including new minor versions and patch releases — are applied automatically in the next available [maintenance window](#define-your-maintenance-window). The upgrade is first applied to your standard {C.SERVICE_SHORT}s tagged `#dev`, and three weeks later to those tagged `#prod`. [Subscribe](https://status.tigerdata.com/) to get an email notification before your `#prod` {C.SERVICE_SHORT}s are upgraded. If there are no pending upgrades during a maintenance window, no changes are performed. |
There was a problem hiding this comment.
@miqrc can you provide additional details here, on the phased rollout?
There was a problem hiding this comment.
Why do we call them standard? Also, we don't send notifications from the infra for individual DBs. We just announce the release and what is going to happen. Here's the example announcement, which is also contained in emails that are sent by our status page.
| Non-critical upgrades — including new minor versions and patch releases — are applied automatically in the next available [maintenance window](#define-your-maintenance-window). The upgrade is first applied to your standard {C.SERVICE_SHORT}s tagged `#dev`, and three weeks later to those tagged `#prod`. [Subscribe](https://status.tigerdata.com/) to get an email notification before your `#prod` {C.SERVICE_SHORT}s are upgraded. If there are no pending upgrades during a maintenance window, no changes are performed. | |
| Non-critical upgrades — including new minor versions and patch releases — are applied automatically in the next available [maintenance window](#define-your-maintenance-window). The upgrade is first applied to your {C.SERVICE_SHORT}s tagged `#dev`, and three weeks later to those tagged `#prod`. [Subscribe](https://status.tigerdata.com/) to get an email notification before your `#dev` {C.SERVICE_SHORT}s are upgraded. No separate notification is sent when your prod service is updated. If there are no pending upgrades during a maintenance window, no changes are performed. |
There was a problem hiding this comment.
@atovpeko This is the text I would use here (please apply the templating if needed, i.e. SERVICE_SHORT, etc.)
Non-critical upgrades
Non-critical upgrades — new minor versions and patch releases — are applied automatically in the next available maintenance window. Subscribe to get an email notification before your {C.SERVICE_SHORT}s are upgraded. If there are no pending upgrades during a maintenance window, no changes are performed.
The schedule depends on the upgrade type and your service's environment tag:
- New minor versions on
#devservices: applied in the next maintenance window after the release. - New minor versions on
#prodservices: applied in the next maintenance window three weeks after the release. This gives you three weeks to validate the release on your#devservices first. - Patch releases: applied in the next maintenance window on both
#devand#prodservices, with no waiting period.
Occasionally, a new minor version is released before the previous one has completed its three-week window — for example, when it contains an important fix. In that case, the newer minor version takes priority: your #prod services skip the previous minor and target the new one instead, and the three-week window restarts from the new release. Your #dev services move to the new minor in their next maintenance window, as usual.
Describe your changes
Restructures the Tiger Cloud "Maintenance and upgrades" page (
src/partials/_upgrades.mdx) into two clearly separated top-level sections — TimescaleDB upgrades and PostgreSQL upgrades — based on which component is being upgraded, so readers can find what applies to them without conflating the two products.Key changes:
Non-critical upgradescovers minor versions and patch releases (renamed from the ambiguous "Minor software upgrades").Critical security patchesis now its own subsection rather than buried in a bullet.Downtime and connection resetssubsection consolidates scattered downtime guidance and absorbs the rewritten "Minimize downtime with replicas" content. The failover mechanics are explained more clearly.Check your current versionssection pointing readers toOperations>Service Upgradesin Console, with a screenshot.ThemeImagepairs (light + dark) for the existing maintenance-window image and the new Service Upgrades image.#define-your-maintenance-window, from_migrate_prerequisites.mdx) is preserved.Open items to confirm with engineering:
Affected pages
https://tiger-data-docs-git-atovpeko1-edu-540-rework-c-32a5c2-tigerdata.vercel.app/deploy/tiger-cloud/tiger-cloud-aws/upgrades
Related Issues
EDU-540 — Rework Cloud upgrade docs for clarity
Checklist before requesting a review