Update plan-persistence.mdx #2007
Conversation
WalkthroughThe documentation for plan persistence was revised for clarity and correctness, including rephrasing explanations and correcting the spelling of "artefacts" to "artifacts." No code or functional changes were made. Changes
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ Context from checks skipped due to timeout of 90000ms (1)
✨ Finishing Touches🧪 Generate Unit Tests
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
There was a problem hiding this comment.
PR Summary
Fixed spelling inconsistency in docs/ce/features/plan-persistence.mdx by standardizing the spelling of 'artifacts'.
- The document still contains mixed usage of both 'artefacts' and 'artifacts' spellings - consider updating remaining instances for consistency
1 file reviewed, 1 comment
Edit PR Review Bot Settings | Greptile
| @@ -2,4 +2,4 @@ | |||
| title: "Plan Persistence" | |||
| --- | |||
|
|
|||
| By default digger will run an apply based on the branch pull request files (no artefacts stored). In order to configure plan artefacts you can configure the inputs for storing as github artefacts or aws buckets or gcp buckets. The corresponding artefacts to be configured can be found in [storing plans in a bucket](/ce/howto/store-plans-in-a-bucket) | |||
| By default digger will run an apply based on the branch pull request files (no artefacts stored). In order to configure plan artifacts you can configure the inputs for storing as github artefacts or aws buckets or gcp buckets. The corresponding artefacts to be configured can be found in [storing plans in a bucket](/ce/howto/store-plans-in-a-bucket) | |||
There was a problem hiding this comment.
style: Still using mixed spelling: 'artifacts'/'artefacts' in same sentence. Consider standardizing to either US ('artifacts') or UK ('artefacts') spelling throughout
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
docs/ce/features/plan-persistence.mdx (1)
5-5: Unify spelling and polish phrasingMixed “artefacts”/“artifacts”, the unusual “run an apply”, and a couple of missing commas break the flow. A concise rewrite keeps terminology consistent and improves readability.
-By default digger will run an apply based on the branch pull request files (no artefacts stored). In order to configure plan artifacts you can configure the inputs for storing as github artefacts or aws buckets or gcp buckets. The corresponding artefacts to be configured can be found in [storing plans in a bucket](/ce/howto/store-plans-in-a-bucket) +By default, Digger runs the apply step on the pull-request branch files (no artifacts are stored). To enable plan artifact persistence, configure the inputs to store them as GitHub artifacts, AWS buckets, or GCP buckets. The corresponding artifacts are documented in [storing plans in a bucket](/ce/howto/store-plans-in-a-bucket).
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/ce/features/plan-persistence.mdx(1 hunks)
🧰 Additional context used
🧠 Learnings (1)
docs/ce/features/plan-persistence.mdx (1)
Learnt from: wenzel-felix
PR: diggerhq/digger#1933
File: libs/storage/plan_storage.go:396-429
Timestamp: 2025-04-03T16:18:59.062Z
Learning: The implementation of cloud storage providers in Digger (AWS, GCP, Azure) intentionally does not check for or attempt to create storage resources (buckets, containers) to minimize required permissions. Storage resources are expected to exist prior to execution.
🪛 LanguageTool
docs/ce/features/plan-persistence.mdx
[grammar] ~5-~5: The verb ‘apply’ does not usually follow articles like ‘an’. Check that ‘apply’ is spelled correctly; using ‘apply’ as a noun may be non-standard.
Context: ...stence" --- By default digger will run an apply based on the branch pull request files ...
(A_INFINITIVE)
[style] ~5-~5: Consider a more concise word here.
Context: ...ll request files (no artefacts stored). In order to configure plan artifacts you can config...
(IN_ORDER_TO_PREMIUM)
[uncategorized] ~5-~5: Possible missing comma found.
Context: ...cts stored). In order to configure plan artifacts you can configure the inputs for storin...
(AI_HYDRA_LEO_MISSING_COMMA)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Security Check
fix typo
Summary by CodeRabbit