Skip to content
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

Add User Documentation #90

Open
n-boshnakov opened this issue Oct 15, 2024 · 0 comments
Open

Add User Documentation #90

n-boshnakov opened this issue Oct 15, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@n-boshnakov
Copy link

What would you like to be added:

I would like to suggest that user documentation be added for the ACL extension.

As a general idea, the user documentation could contain:
• How to enable the extension
• How to configure the extension
• Tutorials (if needed)

Good examples of user documentation:
https://github.com/gardener/gardener-extension-registry-cache/blob/main/docs/usage/registry-cache/configuration.md
https://github.com/gardener/gardener-extension-provider-aws/blob/master/docs/usage/usage.md

The contents of the main README.md could also be split and used as a starting point for the documentation.

Why is this needed:

This would help users of the ACL extension get started with it more easily and learn how to complete various most common use cases.

@n-boshnakov n-boshnakov added the enhancement New feature or request label Oct 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant