fix(DOC-1958): add lifecycle ignore_changes guidance and prose cleanup#533
Open
fix(DOC-1958): add lifecycle ignore_changes guidance and prose cleanup#533
Conversation
- Add lifecycle block example for throughput_tier to prevent accidental cluster replacement when Redpanda Support upgrades a cluster - Rewrite opening sentence to remove weak verbs - Cut throat-clearing prose throughout (234 net word reduction) - Fix passive voice, future tense, e.g./etc., and Title Case violations - Tighten callout <1> from 9 sentences to 3 - Replace placeholder "your-secret-password" with "schema-registry-password" Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
✅ Deploy Preview for rp-cloud ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
📝 WalkthroughWalkthroughThis pull request updates the Terraform provider documentation file with refined phrasing, improved capitalization consistency, and clarified technical content. Changes include replacing placeholder credentials with more generic equivalents, expanding the Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
📝 Coding Plan
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@modules/manage/pages/terraform-provider.adoc`:
- Line 660: Update the NOTE that currently reads "Terraform deletes a cluster
that depends on a network after it deletes the network" to correctly state
deletion order for dependent resources: the dependent resource (cluster) is
destroyed first, then its dependency (network). Locate the note text string
"NOTE: Terraform deletes dependent resources in the correct order. For example,
Terraform removes a cluster that depends on a network after it deletes the
network." and rephrase it so the example reads that Terraform removes the
cluster first and then the network.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: e2a15053-62d3-4632-a437-bf3a32c50aa7
📒 Files selected for processing (1)
modules/manage/pages/terraform-provider.adoc
| The `terraform destroy` command deletes all resources defined in your configuration. | ||
|
|
||
| NOTE: Terraform ensures that dependent resources are deleted in the correct order. For example, a cluster dependent on a network will be removed after the network. | ||
| NOTE: Terraform deletes dependent resources in the correct order. For example, Terraform removes a cluster that depends on a network after it deletes the network. |
Contributor
There was a problem hiding this comment.
Fix reversed dependency deletion order in the note.
Line 660 currently says Terraform deletes the network before the dependent cluster. That order is backward. For dependent resources, Terraform destroys the dependent resource first (cluster), then the dependency (network).
✏️ Proposed wording fix
-NOTE: Terraform deletes dependent resources in the correct order. For example, Terraform removes a cluster that depends on a network after it deletes the network.
+NOTE: Terraform deletes dependent resources in the correct order. For example, Terraform removes a cluster that depends on a network before it deletes the network.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@modules/manage/pages/terraform-provider.adoc` at line 660, Update the NOTE
that currently reads "Terraform deletes a cluster that depends on a network
after it deletes the network" to correctly state deletion order for dependent
resources: the dependent resource (cluster) is destroyed first, then its
dependency (network). Locate the note text string "NOTE: Terraform deletes
dependent resources in the correct order. For example, Terraform removes a
cluster that depends on a network after it deletes the network." and rephrase it
so the example reads that Terraform removes the cluster first and then the
network.
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
lifecycle { ignore_changes = [throughput_tier] }pattern as a complement toallow_deletion = false, protecting clusters from accidental replacement when Redpanda Support upgrades a throughput tiere.g./etc., and Title Case violations<1>from 9 sentences to 3"your-secret-password"placeholder with"schema-registry-password"Resolves DOC-1958.
Test plan
lifecyclecode block🤖 Generated with Claude Code