Skip to content

docs: fix style in getting-started section - #1050

Open
timonegk wants to merge 1 commit into
gardener:masterfrom
timonegk:style-getting-started
Open

docs: fix style in getting-started section#1050
timonegk wants to merge 1 commit into
gardener:masterfrom
timonegk:style-getting-started

Conversation

@timonegk

Copy link
Copy Markdown

How to categorize this PR?
/kind cleanup

What this PR does / why we need it:

While reading the Getting Started docs for Gardener, I noticed some style inconsistencies or small mistakes (wrong punctuation, inconsistent capitalization, wrong hyphens). I decided to fix them as I was reading the docs.

Special notes for your reviewer:

Feel free to edit the PR if you are not agreeing to the changes.

@timonegk
timonegk requested a review from a team as a code owner August 17, 2026 16:03
@netlify

netlify Bot commented Aug 17, 2026

Copy link
Copy Markdown

Deploy Preview for gardener-docs ready!

Name Link
🔨 Latest commit f069ac5
🔍 Latest deploy log https://app.netlify.com/projects/gardener-docs/deploys/6a840f0e978eac000867682e
😎 Deploy Preview https://deploy-preview-1050--gardener-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

@CLAassistant

CLAassistant commented Aug 17, 2026

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

@gardener-prow gardener-prow Bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Aug 17, 2026
@coderabbitai

coderabbitai Bot commented Aug 17, 2026

Copy link
Copy Markdown
Contributor

Important

Review skipped

Review was skipped due to path filters

⛔ Files ignored due to path filters (21)
  • hugo/content/docs/getting-started/_index.md is excluded by !hugo/content/**
  • hugo/content/docs/getting-started/architecture.md is excluded by !hugo/content/**
  • hugo/content/docs/getting-started/ca-components.md is excluded by !hugo/content/**
  • hugo/content/docs/getting-started/common-pitfalls.md is excluded by !hugo/content/**
  • hugo/content/docs/getting-started/features/certificate-management.md is excluded by !hugo/content/**
  • hugo/content/docs/getting-started/features/cluster-autoscaler.md is excluded by !hugo/content/**
  • hugo/content/docs/getting-started/features/credential-rotation.md is excluded by !hugo/content/**
  • hugo/content/docs/getting-started/features/dns-management.md is excluded by !hugo/content/**
  • hugo/content/docs/getting-started/features/hibernation.md is excluded by !hugo/content/**
  • hugo/content/docs/getting-started/features/vpa.md is excluded by !hugo/content/**
  • hugo/content/docs/getting-started/index.md is excluded by !hugo/content/**
  • hugo/content/docs/getting-started/introduction.md is excluded by !hugo/content/**
  • hugo/content/docs/getting-started/lifecycle.md is excluded by !hugo/content/**
  • hugo/content/docs/getting-started/observability/_index.md is excluded by !hugo/content/**
  • hugo/content/docs/getting-started/observability/alerts.md is excluded by !hugo/content/**
  • hugo/content/docs/getting-started/observability/components.md is excluded by !hugo/content/**
  • hugo/content/docs/getting-started/observability/index.md is excluded by !hugo/content/**
  • hugo/content/docs/getting-started/observability/shoot-status.md is excluded by !hugo/content/**
  • hugo/content/docs/getting-started/podrick-and-the-infinite-garden.md is excluded by !hugo/content/**
  • hugo/content/docs/getting-started/project.md is excluded by !hugo/content/**
  • hugo/content/docs/getting-started/shoots.md is excluded by !hugo/content/**

CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including **/dist/** will override the default block on the dist directory, by removing the pattern from both the lists.

⚙️ Run configuration

Configuration used: Path: .coderabbit.yml

Review profile: CHILL

Plan: Pro Plus

Run ID: 9bd900e9-ba29-4f7b-8d1b-087d1c90d7d9

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

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.

❤️ Share

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

@gardener-prow gardener-prow Bot added the cla: no Indicates the PR's author has not signed the cla-assistant.io CLA. label Aug 17, 2026
@timonegk
timonegk force-pushed the style-getting-started branch from 9bd9883 to d55d8ec Compare August 18, 2026 07:06
@gardener-prow gardener-prow Bot added cla: yes Indicates the PR's author has signed the cla-assistant.io CLA. and removed cla: no Indicates the PR's author has not signed the cla-assistant.io CLA. labels Aug 18, 2026
@timonegk
timonegk force-pushed the style-getting-started branch 2 times, most recently from 5aac484 to 69ccdff Compare August 18, 2026 07:13
@BoHristova BoHristova self-assigned this Aug 18, 2026
@timonegk
timonegk force-pushed the style-getting-started branch from 69ccdff to 4f29d60 Compare August 18, 2026 07:39
@gardener-prow

gardener-prow Bot commented Aug 18, 2026

Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please ask for approval from bohristova. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@timonegk
timonegk force-pushed the style-getting-started branch from 4f29d60 to f069ac5 Compare August 18, 2026 07:51
@BoHristova

Copy link
Copy Markdown
Contributor

Hi @timonegk, thanks for making the Gardener docs better! 🙌

I noticed the recent force-pushes and was wondering whether you're still working on the PR. Do you need some more time before I start reviewing it?

@timonegk

Copy link
Copy Markdown
Author

Hi @BoHristova, thanks for taking a look. I reviewed my changes today and noticed some things I missed. But I think it's ready for your review now. If I see anything else that needs a change, I will add a commit so that you can review them separately.

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

Labels

cla: yes Indicates the PR's author has signed the cla-assistant.io CLA. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants