Skip to content

Extend and clean up the extension section - #1068

Draft
BoHristova wants to merge 14 commits into
gardener:masterfrom
BoHristova:add-missing-extensions
Draft

Extend and clean up the extension section#1068
BoHristova wants to merge 14 commits into
gardener:masterfrom
BoHristova:add-missing-extensions

Conversation

@BoHristova

@BoHristova BoHristova commented Aug 31, 2026

Copy link
Copy Markdown
Contributor

How to categorize this PR?

/kind enhancement cleanup

What this PR does / why we need it:

This PR brings the List of Extensions section of the documentation up to date with the Known Extension Implementations list maintained in gardener/gardener.

Еxtensions added:

Infrastructure providers

  • KubeVirt the extension isn't actively maintained anymore
  • vSphere (had to be excluded from the current PR because unescaped angle brackets in the source docs were causing a build error; will be added in a different PR after the problem is fixed) the extension is not maintained anymore

Operating system

Others

Sidebar improvements

  • Renamed section "List of Extensions" → "Extensions"
  • Removed redundant category words from sidebar labels (e.g. "OS", "CNI", "Provider") to keep labels concise
  • Updated sidebar labels to align more closely with upstream implementation names (e.g. "Falco" → "Falco Service", "Node Audit Logging" → "Rsyslog RELP")
  • Added weight frontmatter to all Others entries to enforce consistent alphabetical order

Which issue(s) this PR fixes:
Related to #1023

Special notes for your reviewer:

Summary by CodeRabbit

Documentation

  • Improved extension documentation navigation with clearer, more consistent section, provider, and page titles.
  • Reordered documentation entries and added weights for predictable page placement.
  • Added documentation entries for additional infrastructure, operating system, and community extensions.
  • Updated network and container runtime page titles for consistency.
  • Added file-tree links to selected operating system documentation pages.

@BoHristova
BoHristova requested a review from a team as a code owner August 31, 2026 14:38
@gardener-prow gardener-prow Bot added kind/enhancement Enhancement, improvement, extension kind/cleanup Something that is not needed anymore and can be cleaned up labels Aug 31, 2026
@netlify

netlify Bot commented Aug 31, 2026

Copy link
Copy Markdown

Deploy Preview for gardener-docs ready!

Name Link
🔨 Latest commit 3a3ca69
🔍 Latest deploy log https://app.netlify.com/projects/gardener-docs/deploys/6a9676284783700008ad1658
😎 Deploy Preview https://deploy-preview-1068--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.

@gardener-prow gardener-prow Bot added needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Aug 31, 2026
@gardener-prow

gardener-prow Bot commented Aug 31, 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 assign marc1404 for approval. 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

@coderabbitai

coderabbitai Bot commented Aug 31, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yml

Review profile: CHILL

Plan: Team

Run ID: 0c059901-e1d0-4aa1-a2b4-6b85afd3085b

📥 Commits

Reviewing files that changed from the base of the PR and between 7664c21 and 3a3ca69.

⛔ Files ignored due to path filters (1)
  • hugo/content/docs/extensions/others/acl-extension.md is excluded by !hugo/content/**
📒 Files selected for processing (7)
  • .docforge/documentation/documentation.yaml
  • .docforge/documentation/gardener-extensions/container-runtime.yaml
  • .docforge/documentation/gardener-extensions/gardener-extensions.yaml
  • .docforge/documentation/gardener-extensions/infrastructure.yaml
  • .docforge/documentation/gardener-extensions/network.yaml
  • .docforge/documentation/gardener-extensions/operating-system.yaml
  • .docforge/documentation/gardener-extensions/others.yaml
🚧 Files skipped from review as they are similar to previous changes (6)
  • .docforge/documentation/gardener-extensions/network.yaml
  • .docforge/documentation/gardener-extensions/container-runtime.yaml
  • .docforge/documentation/gardener-extensions/gardener-extensions.yaml
  • .docforge/documentation/documentation.yaml
  • .docforge/documentation/gardener-extensions/operating-system.yaml
  • .docforge/documentation/gardener-extensions/others.yaml

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

The documentation configuration updates navigation titles, extension ordering, provider and extension names, numeric weights, and Gardener extension entries.

Changes

Documentation catalog

Layer / File(s) Summary
Category navigation titles
.docforge/documentation/documentation.yaml, .docforge/documentation/gardener-extensions/gardener-extensions.yaml, .docforge/documentation/gardener-extensions/container-runtime.yaml
Top-level and extension category titles were shortened. The gVisor page title was changed to gVisor.
Infrastructure, operating system, and network indexes
.docforge/documentation/gardener-extensions/infrastructure.yaml, .docforge/documentation/gardener-extensions/operating-system.yaml, .docforge/documentation/gardener-extensions/network.yaml
Entries were reordered and assigned numeric weights. Provider, operating system, and network titles were simplified. A metal-stack operating system entry was added. File-tree links were added to two operating system entries.
Additional extension entries
.docforge/documentation/gardener-extensions/others.yaml
The index was reordered and expanded with new extensions. Existing titles were renamed and assigned numeric weights.

Estimated code review effort: 2 (Simple) | ~10 minutes

Merge Risk: ⚪ Minimal · up to 3a3ca

This PR updates extension documentation and sidebar naming without changing product behavior or runtime systems; no actionable merge-blocking risk remains beyond normal checks and review.

Suggested reviewers: n-boshnakov, dimitar-kostadinov

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Title check ✅ Passed The title clearly summarizes the main changes: extending and cleaning up the documentation Extensions section.
Description check ✅ Passed The description includes the PR category, purpose, detailed changes, related issue, and reviewer context. The issue is marked as related rather than using the template's exact “Fixes #” format, but th…
Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (7 skipped: 7 unsupported.)

Full details: Description check

Explanation

The description includes the PR category, purpose, detailed changes, related issue, and reviewer context. The issue is marked as related rather than using the template's exact “Fixes #” format, but the required context is present.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with 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.

❤️ Share

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

@BoHristova
BoHristova force-pushed the add-missing-extensions branch from b0b0f66 to 5817737 Compare August 31, 2026 14:42
@gardener-prow gardener-prow Bot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Aug 31, 2026
Signed-off-by: Bozhidara Hristova <bozhidara.hristova@sap.com>
Signed-off-by: Bozhidara Hristova <bozhidara.hristova@sap.com>
Signed-off-by: Bozhidara Hristova <bozhidara.hristova@sap.com>
Signed-off-by: Bozhidara Hristova <bozhidara.hristova@sap.com>
FalcoExtension.md seems to be an enhancement proposal. Moreover, it contains a broken image path, which leads to an error when running Docforge

Signed-off-by: Bozhidara Hristova <bozhidara.hristova@sap.com>
Signed-off-by: Bozhidara Hristova <bozhidara.hristova@sap.com>
Signed-off-by: Bozhidara Hristova <bozhidara.hristova@sap.com>
Signed-off-by: Bozhidara Hristova <bozhidara.hristova@sap.com>
Signed-off-by: Bozhidara Hristova <bozhidara.hristova@sap.com>
Signed-off-by: Bozhidara Hristova <bozhidara.hristova@sap.com>
Signed-off-by: Bozhidara Hristova <bozhidara.hristova@sap.com>
@BoHristova
BoHristova force-pushed the add-missing-extensions branch from 5817737 to ffaaabe Compare August 31, 2026 14:46
@github-actions

github-actions Bot commented Aug 31, 2026

Copy link
Copy Markdown
Contributor

Sitemap structure diff vs master

count
➕ added pages 0
➖ removed pages 0

First entries (full diff in the run summary & artifact):

ADDED   (0):
  (none)
REMOVED (0):
  (none)

A rename appears as one removed (old path) + one added (new path).

Signed-off-by: Bozhidara Hristova <bozhidara.hristova@sap.com>
@BoHristova
BoHristova force-pushed the add-missing-extensions branch from ffaaabe to 9212f5f Compare August 31, 2026 14:53
@BoHristova BoHristova added the area/ipcei IPCEI (Important Project of Common European Interest) label Aug 31, 2026
@BoHristova

Copy link
Copy Markdown
Contributor Author

The build is failing because there are unescaped angle brackets in one of the pulled documents for the vSphere extension: https://github.com/gardener-attic/gardener-extension-provider-vsphere/blob/642bbe1c04fb7e2f9f767cad5b87c42b16057af8/docs/usage/prepare-vsphere.md?plain=1#L237.

I'll remove the extension from the current PR and add it as soon as the problem is fixed in the source repository.

Signed-off-by: Bozhidara Hristova <bozhidara.hristova@sap.com>
Signed-off-by: Bozhidara Hristova <bozhidara.hristova@sap.com>
@coderabbitai

coderabbitai Bot commented Sep 1, 2026

Copy link
Copy Markdown
Contributor

Note

GitHub couldn't provide a complete incremental comparison for this pull request, so CodeRabbit is performing a full review instead. This review may take a little longer.

@BoHristova

Copy link
Copy Markdown
Contributor Author

Blocked by #1071

@marc1404

marc1404 commented Sep 4, 2026

Copy link
Copy Markdown
Member

Blocked by #1071

@BoHristova, I'll convert the PR to a draft and put it on hold until the issue is resolved, since the changes aren't visible in the Netlify preview deployment.

/hold

@gardener-prow gardener-prow Bot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Sep 4, 2026
@marc1404
marc1404 marked this pull request as draft September 4, 2026 07:31
@gardener-prow gardener-prow Bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Sep 4, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/ipcei IPCEI (Important Project of Common European Interest) do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. kind/cleanup Something that is not needed anymore and can be cleaned up kind/enhancement Enhancement, improvement, extension 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.

2 participants