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

Simplify docs for supported versions #4547

Open
theunrepentantgeek opened this issue Jan 29, 2025 · 0 comments
Open

Simplify docs for supported versions #4547

theunrepentantgeek opened this issue Jan 29, 2025 · 0 comments

Comments

@theunrepentantgeek
Copy link
Member

theunrepentantgeek commented Jan 29, 2025

Describe the current behavior

For each supported resource group, we currently have a list of all supported resources, across all supported versions. When the group has a lot of different versions, we end up with a lot of repetition.

Describe the improvement

Break the existing list of "Released" resources into two groups - recommended and supported - so that it's easier for users to spot the one they want (and to guide users towards using more recent versions).

  • Recommended - the latest supported version of each resource, preferring stable if available
  • Supported - all the other resources

For some of the smaller groups, the "Supported" list would be empty, and omitted.

Additional context

For DBforPostgreSQL resources, the division would look like this:

Recommended

These are the recommended resource versions to use.

Resource ARM Version CRD Version Supported From Sample
FlexibleServer 2022-12-01 v1api20221201 v2.5.0 View
FlexibleServersConfiguration 2022-12-01 v1api20221201 v2.5.0 View
FlexibleServersDatabase 2022-12-01 v1api20221201 v2.5.0 View
FlexibleServersFirewallRule 2022-12-01 v1api20221201 v2.5.0 View
User v1 v1 v2.0.0 View

Supported

In addition to the recommended versions listed above, these resources versions are also supported.

Resource ARM Version CRD Version Supported From Sample
FlexibleServer 2023-06-01-preview v1api20230601preview v2.6.0 View
FlexibleServer 2022-01-20-preview v1api20220120preview v2.0.0 View
FlexibleServer 2021-06-01 v1api20210601 v2.0.0 View
FlexibleServersConfiguration 2023-06-01-preview v1api20230601preview v2.6.0 View
FlexibleServersConfiguration 2022-01-20-preview v1api20220120preview v2.0.0 View
FlexibleServersConfiguration 2021-06-01 v1api20210601 v2.0.0 View
FlexibleServersDatabase 2023-06-01-preview v1api20230601preview v2.6.0 View
FlexibleServersDatabase 2022-01-20-preview v1api20220120preview v2.0.0 View
FlexibleServersDatabase 2021-06-01 v1api20210601 v2.0.0 View
FlexibleServersFirewallRule 2023-06-01-preview v1api20230601preview v2.6.0 View
FlexibleServersFirewallRule 2022-01-20-preview v1api20220120preview v2.0.0 View
FlexibleServersFirewallRule 2021-06-01 v1api20210601 v2.0.0 View
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Development

No branches or pull requests

1 participant