-
Notifications
You must be signed in to change notification settings - Fork 85
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.
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
base: master
Are you sure you want to change the base?
Conversation
|
@dimityrmirchev Label kind/ehnancement does not exist. |
|
/kind enhancement |
🚀 Preview DeployedYour preview is being built and will be available at: Note: The preview will only be available after the GitHub Pages deployment completes in the demo repository. To view the deployment status, visit: https://github.com/gardener/documentation-demo/actions |
| 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 |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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:

There was a problem hiding this comment.
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.
What this PR does / why we need it:
/kind ehnancement
/area audit-logging
Which issue(s) this PR fixes:
Fixes #
Special notes for your reviewer:
/cc @vpnachev
Release note: