Skip to content

Test vale errors on master#5

Open
BoHristova wants to merge 1 commit into
masterfrom
test-vale-errors
Open

Test vale errors on master#5
BoHristova wants to merge 1 commit into
masterfrom
test-vale-errors

Conversation

@BoHristova
Copy link
Copy Markdown
Owner

@BoHristova BoHristova commented Apr 22, 2026

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:

@github-actions
Copy link
Copy Markdown

github-actions Bot commented Apr 22, 2026

Vale Linting Check

Summary: 3 errors, 5 warnings found

❌ Errors (3)
File Line Rule Message
website/documentation/getting-started/introduction.md 59 Gardener.Spelling Did you really mean 'hyperscalers'?
website/documentation/getting-started/introduction.md 61 Gardener.Terms Use 'Gardener' instead of 'gardener'.
website/documentation/getting-started/introduction.md 61 Gardener.Terms Use 'Gardener' instead of 'gardener'.
⚠️ Warnings (5)
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

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 22, 2026

Note

Reviews paused

It 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 reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review

Walkthrough

Replaced “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

Cohort / File(s) Summary
Introduction file — minor text edits
website/documentation/getting-started/introduction.md
Replaced one occurrence of “Gardener” with “gardener” and appended a sentence about configuring access via a whitelist. No other edits to file content or structure.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

I nudged a cap and added a line,
Lowered a name, then noted access by design. 🐇

🚥 Pre-merge checks | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Vale Linting Check ❓ Inconclusive Unable to locate Vale configuration or verify the modified markdown file against Vale linting rules without access to the repository. Provide the Vale configuration file path and the modified markdown file to perform lint verification.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

📥 Commits

Reviewing files that changed from the base of the PR and between c62ff29 and deee78a.

📒 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?
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🔴 Critical

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.

Suggested change
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.

@BoHristova
Copy link
Copy Markdown
Owner Author

@coderabbitai full review

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 23, 2026

✅ Actions performed

Full review triggered.

@github-actions
Copy link
Copy Markdown

Vale Linting Results

Summary: 2 suggestions found

💡 Suggestions (2)
File Line Rule Message
website/documentation/getting-started/introduction.md 8 Elastic.WordChoice Consider using 'allowlist' instead of 'whitelist', unless the term is in the UI.
website/documentation/getting-started/introduction.md 12 Elastic.WordChoice Consider using 'efficient, basic' instead of 'simple', unless the term is in the UI.

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.


### 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.
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Elastic.DontUse: Don't use 'Just'.


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.
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Gardener.SecondPerson: Use 'you can' instead of 'The user can'. Address the reader directly as 'you'.


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.
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Gardener.Links: Avoid generic link text 'here'. Use a descriptor of the link's destination instead.


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.
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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".
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Elastic.BritishSpellings: Use American English spelling 'toward' instead of British English 'towards'.


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".
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Elastic.QuotesPunctuation: Place punctuation inside closing quotation marks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant