Test vale errors on master#5
Conversation
Vale Linting CheckSummary: 3 errors, 5 warnings found ❌ Errors (3)
|
| File | Line | Rule | Message |
|---|---|---|---|
website/documentation/getting-started/introduction.md |
59 | Elastic.DontUse | Don't use 'Just'. |
website/documentation/getting-started/introduction.md |
61 | Gardener.SecondPerson | Use 'you can' instead of 'The user can'. Address the reader directly as 'you'. |
website/documentation/getting-started/introduction.md |
61 | Gardener.Links | Avoid generic link text 'here'. Use a descriptor of the link's destination instead. |
website/documentation/getting-started/introduction.md |
63 | Elastic.BritishSpellings | Use American English spelling 'toward' instead of British English 'towards'. |
website/documentation/getting-started/introduction.md |
63 | Elastic.QuotesPunctuation | Place punctuation inside closing quotation marks. |
Vale checks documentation changes against the Gardener style guide and the Elastic style guide. Please try to fix all errors and warnings.
Fix it with AI
Use the following prompt with your AI coding assistant:
The following issues were found by Vale, a prose linter that checks documentation against the Gardener and Elastic style guides.
Before fixing anything, read each flagged line in context and judge whether the finding is a real issue. Vale sometimes reports false positives — only fix a finding if it genuinely violates the style guide. Skip it if the text looks correct as-is. You can verify your fixes locally by running 'make vale'.
Errors:
- In `website/documentation/getting-started/introduction.md`, line 59 (Gardener.Spelling): Did you really mean 'hyperscalers'?
- In `website/documentation/getting-started/introduction.md`, line 61 (Gardener.Terms): Use 'Gardener' instead of 'gardener'.
- In `website/documentation/getting-started/introduction.md`, line 61 (Gardener.Terms): Use 'Gardener' instead of 'gardener'.
Warnings:
- In `website/documentation/getting-started/introduction.md`, line 59 (Elastic.DontUse): Don't use 'Just'.
- In `website/documentation/getting-started/introduction.md`, line 61 (Gardener.SecondPerson): Use 'you can' instead of 'The user can'. Address the reader directly as 'you'.
- In `website/documentation/getting-started/introduction.md`, line 61 (Gardener.Links): Avoid generic link text 'here'. Use a descriptor of the link's destination instead.
- In `website/documentation/getting-started/introduction.md`, line 63 (Elastic.BritishSpellings): Use American English spelling 'toward' instead of British English 'towards'.
- In `website/documentation/getting-started/introduction.md`, line 63 (Elastic.QuotesPunctuation): Place punctuation inside closing quotation marks.
Upstream: BoHristova/documentation
Branch: test-vale-errors
f3ff59c to
deee78a
Compare
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
WalkthroughReplaced “Gardener” with lowercase “gardener” in the “Problem Space” sentence of the introduction and added one sentence to the same paragraph stating that users can configure access via a whitelist. No other files, structure, or content were modified. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Poem
🚥 Pre-merge checks | ❌ 1❌ Failed checks (1 inconclusive)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Comment |
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 `@website/documentation/getting-started/introduction.md`:
- Line 8: Revert the lowercase change and restore the product name
capitalization "Gardener" (not "gardener") in the sentence that starts "Let's
discuss the problem space first..." to satisfy the Vale rule Gardener.Terms and
prevent the CI failure; ensure every occurrence in that sentence uses the
canonical "Gardener" spelling.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro Plus
Run ID: a28583f5-ae00-43e8-8ea0-a56489e3ec20
📒 Files selected for processing (1)
website/documentation/getting-started/introduction.md
| ## Problem Space | ||
|
|
||
| Let's discuss the problem space first. Why does anyone need something like Gardener? | ||
| Let's discuss the problem space first. Why does anyone need something like gardener? |
There was a problem hiding this comment.
Restore canonical product capitalization to pass Vale
Line 8 changes Gardener to gardener, which triggers Gardener.Terms and breaks CI. Please revert this before merging to master.
Proposed fix
-Let's discuss the problem space first. Why does anyone need something like gardener?
+Let's discuss the problem space first. Why does anyone need something like Gardener?📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| Let's discuss the problem space first. Why does anyone need something like gardener? | |
| Let's discuss the problem space first. Why does anyone need something like Gardener? |
🧰 Tools
🪛 GitHub Actions: Vale
[error] 8-8: vale Gardener.Terms: Use 'Gardener' instead of 'gardener'.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@website/documentation/getting-started/introduction.md` at line 8, Revert the
lowercase change and restore the product name capitalization "Gardener" (not
"gardener") in the sentence that starts "Let's discuss the problem space
first..." to satisfy the Vale rule Gardener.Terms and prevent the CI failure;
ensure every occurrence in that sentence uses the canonical "Gardener" spelling.
deee78a to
085e393
Compare
9031996 to
4cf4bf3
Compare
|
@coderabbitai full review |
✅ Actions performedFull review triggered. |
4cf4bf3 to
1fcfbe7
Compare
1fcfbe7 to
919c46c
Compare
Vale Linting ResultsSummary: 2 suggestions found 💡 Suggestions (2)
The Vale linter checks documentation changes against the Elastic Docs style guide. To use Vale locally or report issues, refer to Elastic style guide for Vale. |
919c46c to
1ec9db7
Compare
a249c2f to
ed99a40
Compare
|
|
||
| ### The Reason Why We Choose to "Make It" | ||
|
|
||
| Gardener allows to run Kubernetes clusters on various hyperscalers. It offers the same set of basic configuration options independent of the chosen infrastructure. This kind of harmonization supports any multi-vendor strategy while reducing adoption costs for the individual teams. Just imagine having to deal with multiple vendors all offering vastly different Kubernetes clusters. |
There was a problem hiding this comment.
❌ Gardener.Spelling: Did you really mean 'hyperscalers'?
|
|
||
| ### The Reason Why We Choose to "Make It" | ||
|
|
||
| Gardener allows to run Kubernetes clusters on various hyperscalers. It offers the same set of basic configuration options independent of the chosen infrastructure. This kind of harmonization supports any multi-vendor strategy while reducing adoption costs for the individual teams. Just imagine having to deal with multiple vendors all offering vastly different Kubernetes clusters. |
There was a problem hiding this comment.
|
|
||
| Gardener allows to run Kubernetes clusters on various hyperscalers. It offers the same set of basic configuration options independent of the chosen infrastructure. This kind of harmonization supports any multi-vendor strategy while reducing adoption costs for the individual teams. Just imagine having to deal with multiple vendors all offering vastly different Kubernetes clusters. | ||
|
|
||
| The user can whitelist certain namespaces using a blacklist approach. Click [here](https://gardener.cloud) to learn more. gardener is designed to run at scale. |
There was a problem hiding this comment.
|
|
||
| Gardener allows to run Kubernetes clusters on various hyperscalers. It offers the same set of basic configuration options independent of the chosen infrastructure. This kind of harmonization supports any multi-vendor strategy while reducing adoption costs for the individual teams. Just imagine having to deal with multiple vendors all offering vastly different Kubernetes clusters. | ||
|
|
||
| The user can whitelist certain namespaces using a blacklist approach. Click [here](https://gardener.cloud) to learn more. gardener is designed to run at scale. |
There was a problem hiding this comment.
|
|
||
| Gardener allows to run Kubernetes clusters on various hyperscalers. It offers the same set of basic configuration options independent of the chosen infrastructure. This kind of harmonization supports any multi-vendor strategy while reducing adoption costs for the individual teams. Just imagine having to deal with multiple vendors all offering vastly different Kubernetes clusters. | ||
|
|
||
| The user can whitelist certain namespaces using a blacklist approach. Click [here](https://gardener.cloud) to learn more. gardener is designed to run at scale. |
There was a problem hiding this comment.
❌ Gardener.Terms: Use 'Gardener' instead of 'gardener'.
|
|
||
| Gardener allows to run Kubernetes clusters on various hyperscalers. It offers the same set of basic configuration options independent of the chosen infrastructure. This kind of harmonization supports any multi-vendor strategy while reducing adoption costs for the individual teams. Just imagine having to deal with multiple vendors all offering vastly different Kubernetes clusters. | ||
|
|
||
| The user can whitelist certain namespaces using a blacklist approach. Click [here](https://gardener.cloud) to learn more. gardener is designed to run at scale. |
There was a problem hiding this comment.
❌ Gardener.Terms: Use 'Gardener' instead of 'gardener'.
|
|
||
| The user can whitelist certain namespaces using a blacklist approach. Click [here](https://gardener.cloud) to learn more. gardener is designed to run at scale. | ||
|
|
||
| Of course, there are plenty more reasons - from acquiring operational knowledge to having influence on the developed features - that made the pendulum swing towards "make it". |
There was a problem hiding this comment.
|
|
||
| The user can whitelist certain namespaces using a blacklist approach. Click [here](https://gardener.cloud) to learn more. gardener is designed to run at scale. | ||
|
|
||
| Of course, there are plenty more reasons - from acquiring operational knowledge to having influence on the developed features - that made the pendulum swing towards "make it". |
There was a problem hiding this comment.
ed99a40 to
280dab8
Compare
501ceb0 to
d431bcc
Compare
d431bcc to
e6b0626
Compare
370cc2a to
05e7704
Compare
How to categorize this PR?
/kind TODO
What this PR does / why we need it:
Which issue(s) this PR fixes:
Fixes #
Special notes for your reviewer: