Skip to content

chore: Checkpoint service documentation - #3050

Open
sondermanish wants to merge 7 commits into
mainfrom
chore/checkpoint-docs
Open

sondermanish wants to merge 7 commits into
mainfrom
chore/checkpoint-docs

Conversation

@sondermanish

@sondermanish sondermanish commented Sep 30, 2026 •

Copy link
Copy Markdown
Contributor

Description

Documents upgrade checkpoints for self-hosted instances, and cleans up the related upgrade pages.

New page: Upgrade checkpoints

instance-management/upgrade-checkpoints.mdx (added to the sidebar under Upgrade Appsmith versions)

  • Explains what an upgrade checkpoint is, and that it applies to self-hosted instances only (not Appsmith Cloud).
  • How to confirm or skip a pending checkpoint in Admin central.
  • What to do if the server does not start because a checkpoint was missed: the APPSMITH BACKEND START ABORTED — CHECKPOINT MISSED log message, steps to roll back to the checkpoint version, and the APPSMITH_CHECKPOINT_OVERRIDE environment variable.
  • What Admin central records after a checkpoint is complete.

Admin central

  • Updated the intro: most notices are informational, but pending upgrade checkpoints must be confirmed or skipped before you can upgrade past them.
  • Uses "notices" consistently in place of "communications", and tightens wording throughout.
  • Added links to Upgrade checkpoints.

Upgrade Appsmith versions (update-appsmith.mdx)

  • Wording pass on prerequisites, platform steps, troubleshooting, and See also.
  • Rewrote the checkpoint callouts so they are complete sentences with clear version ranges, and linked them to the matching sections of the checkpoint versions page.
  • Fixed list indentation in the Kubernetes steps.
  • Added Upgrade checkpoints to See also.

Upgrade to Checkpoint Versions (upgrade-to-checkpoint-version.mdx)

  • Restructured the page under a single title, with a table showing which checkpoints apply to each starting version.
  • Split the v1.9.2 and v1.96–v1.99 checkpoints into their own sections with numbered steps.
  • Content fix: the v1.9.2 steps now finish on v1.99 instead of latest. Because latest is now 2.x, the old steps skipped the required v1.96–v1.99 checkpoint. The upgrade path for versions earlier than v1.9.2 is now v1.9.2 → v1.99 → 2.x.
  • Fixed typos ("recommneded", "one of the version"), duplicate step numbering, and US spelling.

Check the appropriate box:

  • Review Fixes
  • Documentation Overhaul
  • Feature/Story
    • Link one or more Engineering Tickets
      *
  • A-Force
  • Error in documentation
  • Maintenance

Documentation tickets

Link to one or more documentation tickets:

Checklist

From the below options, select the ones that are applicable:

  • Checked for Grammarly suggestions.
  • Adhered to the writing checklist.
  • Adhered to the media checklist.
  • Verified and updated cross-references or added redirect rules.
  • Tested the redirect rules on deploy preview.
  • Validated the modifications made to the content on the deploy preview.
  • Validated the CSS modifications on different screen sizes.

🤖 Generated with Claude Code

https://claude.ai/code/session_01TRDhQSGiwZSGG9XzEH2Ppv

@vercel

vercel Bot commented Sep 30, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
appsmith-docs Ready Ready Preview Oct 1, 2026 2:24pm UTC

Request Review

@sondermanish sondermanish changed the title docs for checkpointing chore: Checkpoint service documentation Sep 30, 2026
@@ -38,7 +38,11 @@ Appsmith adds a notice when a change in an upcoming or current release requires
- An expandable list of affected items when more context is available
- A **Learn more** link to the documentation for that change

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

These lines here from 41 forward seem to be causing a problem with the deploy. These need to be fixed first @sondermanish

claude added 3 commits October 1, 2026 13:53
Clarify phrasing, use consistent terminology (complete/confirm/skip),
and align tone with the rest of the docs.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01TRDhQSGiwZSGG9XzEH2Ppv
Use consistent terminology (notices), tighten phrasing, clarify the
checkpoint version callouts, and fix list indentation in the
Kubernetes steps.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01TRDhQSGiwZSGG9XzEH2Ppv
Fix spelling and grammar in the v1.96-v1.99 intro, correct duplicate
step numbering in the Docker steps, and use US spelling.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01TRDhQSGiwZSGG9XzEH2Ppv
@CLAassistant

Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
1 out of 2 committers have signed the CLA.

✅ sondermanish
❌ claude
You have signed the CLA already but the status is still pending? Let us recheck it.

1 similar comment
@CLAassistant

Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
1 out of 2 committers have signed the CLA.

✅ sondermanish
❌ claude
You have signed the CLA already but the status is still pending? Let us recheck it.

Use a single page title, add a table to find which checkpoints apply,
split the v1.9.2 and v1.96-v1.99 checkpoints into their own sections
with steps, and link to the automated upgrade checkpoints page. Update
links from the Update Appsmith page to the new section anchors.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01TRDhQSGiwZSGG9XzEH2Ppv
The v1.9.2 steps ended on the latest tag, which skips the required
v1.96-v1.99 checkpoint now that latest is 2.x. Pin the final steps to
v1.99 and point to the standard upgrade afterward.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01TRDhQSGiwZSGG9XzEH2Ppv

This branch was successfully deployed

1 active deployment
Preview — 7589f3d3 Deployed Oct 1, 2026 by vercel[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.

5 participants