docs: document app secret rotation and recovery#2359
Draft
Ghaith (Gaitholabi) wants to merge 1 commit into
Draft
docs: document app secret rotation and recovery#2359Ghaith (Gaitholabi) wants to merge 1 commit into
Ghaith (Gaitholabi) wants to merge 1 commit into
Conversation
Adds an operator guide for the app:secret:rotate and app:secret:recover commands and the unconfirmed-secret state model, and folds the rest of the feature into the existing app docs: - command reference: add app:secret:rotate, app:secret:recover, and app:shop-id:change (with the deprecated app:url-change:resolve alias) - app-registration-setup: point shop-id resolution at app:shop-id:change - app-signature-verification: document validating the re-registration dual signature
Developer Docs healthcheckStatus: Completed with |
5 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documents the app secret rotation and recovery feature:
guides/plugins/apps/lifecycle/app-secret-recovery.md): theapp:secret:rotateandapp:secret:recovercommands, theunconfirmed_app_secretsstate model, thedeleted_appsuninstall/reinstall interaction, when to fall back toapp:shop-id:change, limits, and observability.app:secret:rotate,app:secret:recover, andapp:shop-id:change(with the deprecatedapp:url-change:resolvealias).app:shop-id:change(was the deprecatedapp:url-change:resolve) and cross-links the new guide.Related links
Checklist
PageRefreferences where relevant..gitbook.yamlif pages were moved, renamed, or deleted. (N/A — one new page, three edited; nothing moved or renamed.).wordlist.txt(and sorted it) if spellcheck flags new legitimate terms. (No update needed — the example appMyAppandOpenTelemetryare already in the wordlist.)Notes
The repo's
make spellcheck-local/make fixwere not run locally (the tooling needs the docs Docker/pnpm setup; macOS has notimeout). Content was checked by hand: internal links resolve, callouts are balanced, the language guide is respected (no slash conjunctions, no emoji in tables), and new terms are wordlist-accepted or dictionary words. Please let the docs CI confirm spellcheck and markdownlint.