-
Notifications
You must be signed in to change notification settings - Fork 52
Description
Summary of the new feature / enhancement
As a user, I want to be able to tell at a glance whether an instance of a resource in a configuration manages a single instance, a group of instances, or is a provider for other instances.
Right now, there is an informal convention of appending Group
to the type name, but this is used for both resource groups and resource providers.
We should have some standard guidance and follow it for the first-party resources.
Note
This may not be as necessary if #139 is implemented, as we could surface this information more easily in the editor extension and in the CLI output. I think the naming convention would still have some value, but less.
Proposed technical implementation details (optional)
The current documentation for fully qualified type names says:
The name segment of the type name is mandatory. It identifies the component that the resource manages. This segment should be a singular noun unless the resource always manages a list of components in a single resource instance. In that case, the resource name should be the plural form of the noun it manages or the singular form of the noun followed by the word List, like
JeaRoleCapabilities
orJeaRoleCapabilityList
.
We could add additional guidance here for resource groups and providers, like:
If the resource is a resource group, add the
Group
suffix to the name. If it's a resource provider, add theProvider
suffix to the name.