docs: add hotfix-any-environment Mermaid diagrams - #134
Merged
Merged
Conversation
Signed-off-by: Joshua Temple <joshua.temple@stablekernel.com>
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
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.
Problem
The hotfix workflow is one of cascade's distinguishing capabilities (it targets any environment, not just the production tip), but neither the README nor the workflows reference page showed it visually. Readers had to reconstruct the roll-forward-first default, the per-environment integration branch, the resolution PR, and the rejoin path from prose alone.
Fix
## Hotfix any environmentsection. One short paragraph plus a Mermaid diagram that lands a fix on staging (not prod) to emphasize that any environment is a valid target, shows the cherry-pick ontoenv/staging, thecascade-hotfixresolution PR, the staging-only deploy, the diverged-rc.N.hotfix.Mstate, and the rejoin once a trunk SHA containing the fix is promoted. Uses the existing teal/copper theme directive from the other README diagrams.## Hotfixsection in the workflows reference gains a diagram at the top covering the fuller flow: roll forward first, integration branch, clean vs conflict resolution PR, finalize, diverged state, and rejoin under the patch-containment guard. No per-diagram init directive, so it inherits the docs site's global Mermaid theme. The surrounding prose is unchanged.Verification
npm run buildindocs/succeeds;workflows/index.htmlregenerates without error.