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

Improve documentation for crdPattern #3142

Closed
theunrepentantgeek opened this issue Jul 16, 2023 · 1 comment · Fixed by #3207
Closed

Improve documentation for crdPattern #3142

theunrepentantgeek opened this issue Jul 16, 2023 · 1 comment · Fixed by #3207
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@theunrepentantgeek
Copy link
Member

theunrepentantgeek commented Jul 16, 2023

Describe the current behavior

We require users to specify which CRDs they want to have installed. There are a number of ways to do this, but it's not obvious what values to include in the parameter.

Describe the improvements

  1. Add docs for each group on our Supported Resources page giving the exact addition required to bring in those resources, so that someone reading the list of supported resources has the required information available up front.

  2. Break out examples of helm installation using different shells, as there are subtle details different for bash vs cmd.

We may also want to consider making the configuration tolerant of extra quotes.

Additional context

It might look something like this:

AppConfiguration

To install these resources, your ASO configuration must include appconfiguration.azure.com/* as a part of the crdPattern parameter. See CRD Management in ASO for detailed instruction for both Helm and YAML based installation.

Released

These resource(s) are available for use in the current release of ASO. Different versions of a given resource reflect different versions of the Azure ARM API.

... elided ...

@matthchr matthchr added this to the v2.3.0 milestone Jul 17, 2023
@matthchr matthchr added documentation Improvements or additions to documentation and removed needs-triage 🔍 labels Jul 17, 2023
@theunrepentantgeek theunrepentantgeek modified the milestones: v2.4.0, v2.3.0 Jul 24, 2023
@theunrepentantgeek
Copy link
Member Author

Generating crdPattern docs for each resource group was added in #3147.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Development

Successfully merging a pull request may close this issue.

2 participants