Skip to content

Add extension-auditing to documentation #795

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
n-boshnakov merged 1 commit into from
Jan 20, 2026
Merged

Add extension-auditing to documentation #795

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions .docforge/documentation/gardener-extensions/others.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,3 +63,11 @@ structure:
description: Gardener extension controller which configures the rsyslog and auditd services installed on shoot nodes.
source: https://github.com/gardener/gardener-extension-shoot-rsyslog-relp/blob/main/README.md
- fileTree: https://github.com/gardener/gardener-extension-shoot-rsyslog-relp/tree/main/docs
- dir: gardener-extension-auditing
structure:
- file: _index.md
frontmatter:
title: Kubernetes Auditing
description: Gardener extension controller which deploys an auditlog forwarder sending Kubernetes Audit Events to configured backends.
source: https://github.com/gardener/gardener-extension-auditing/blob/main/README.md
- fileTree: https://github.com/gardener/gardener-extension-auditing/tree/main/docs
Copy link
Member

@vpnachev vpnachev Jan 9, 2026

Choose a reason for hiding this comment

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

Do you want the api-reference and development folders to be also added on the website? I think other components are somehow filtering out some of their docs/ folder content to not be shown on the website.

Copy link
Contributor

@n-boshnakov n-boshnakov Jan 9, 2026

Choose a reason for hiding this comment

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

To add to what @vpnachev said, what do you want the final structure of the new section to look like? Adding the content like this would add the entire contents of the development and usage folders to the newly created Kubernetes Auditing section, apart from auditing, which will have its own folder:
image

Copy link
Member Author

@dimityrmirchev dimityrmirchev Jan 12, 2026

Choose a reason for hiding this comment

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

I do not think that all extensions filter out the dev folder. See https://gardener.cloud/docs/extensions/others/gardener-extension-registry-cache/getting-started-locally/. It shows when the the dev persona is selected.

The api-reference folder is also useful especially when not all configuration options are explicitly mentioned in an usage.md file.

Copy link
Member Author

@dimityrmirchev dimityrmirchev Jan 20, 2026

Choose a reason for hiding this comment

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

Hello @vpnachev and @n-boshnakov,

Can we proceed with this PR or should I address something? From my point of view the PR looks good the way it is.