Add extension-auditing to documentation #795
Conversation
|
@dimityrmirchev Label kind/ehnancement does not exist. |
gardener-github-actions
bot
added
the
reviewed/ok-to-test
gardener-robot
added
the
size/XS
|
/kind enhancement |
github-actions
bot
added
needs/ok-to-test
🧹 Preview RemovedThe preview for this PR is no longer available since the PR has been closed. |
| 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.
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.
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.
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.
There was a problem hiding this comment.
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.
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: n-boshnakov The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
LGTM label has been added. DetailsGit tree hash: ae4c8a273efd85d43c5ad7f24a9d99cd1436dc24 |
gardener-prow
bot
added
the
approved
4 participants
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: