RHIDP-5374: Consistent mentions to the product custom resource #859
+25
−25
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
themr0c
reviewed
Jan 20, 2025
| @@ -5,7 +5,7 @@ The {product} operator exposes a `rhdh.redhat.com/v1alpha2` API Version of its C | |||
|
|
|||
| .Procedure | |||
|
|
|||
| . Create a {product-short} Custom Resource Definition with the following fields: | |||
| . Create a `{product-custom-resource-type}` Custom Resource Definition with the following fields: | |||
There was a problem hiding this comment.
Looking at the kind value, this is a custom resource, not a custom resource definition:
Suggested change
| . Create a `{product-custom-resource-type}` Custom Resource Definition with the following fields: | |
| . Create a `{product-custom-resource-type}` custom resource with the following fields: |
themr0c
reviewed
Jan 20, 2025
| @@ -75,9 +75,9 @@ $ oc create configmap rbac-policies \ | |||
| --from-file=rbac-conditional-policies.yaml | |||
| ---- | |||
|
|
|||
| . Update your {product-short} `Backstage` custom resource to mount in the {product-short} filesystem your files from the `rbac-policies` config map: | |||
| . Update your `{product-custom-resource-type}` custom resource to mount in the {product-short} filesystem your files from the `rbac-policies` config map: | |||
There was a problem hiding this comment.
Maybe when we are mentioning "your custom Backstage custom resource", always:
- Specify "your custom" to clarify this is is the user configuration
- Write "custom resource" rather than "CR" to follow OpenShift guidelines.
- Add a link to the configuration guide.
There was a problem hiding this comment.
Suggested change
| . Update your `{product-custom-resource-type}` custom resource to mount in the {product-short} filesystem your files from the `rbac-policies` config map: | |
| . Update your custom `{product-custom-resource-type}` custom resource to mount in the {product-short} filesystem your files from the `rbac-policies` config map: |
There was a problem hiding this comment.
Afterthought: it looks ugly, it would repeat the word custom twice and that would defeat the clarity purpose. Maybe "your {product-custom-resource-type} custom resource" is the still the best. Or do you have any better idea?
themr0c
reviewed
Jan 20, 2025
| @@ -59,7 +59,7 @@ For Operator-based deployment, the approach you use for proxy configuration is b | |||
| ---- | |||
|
|
|||
|
|
|||
| * As a developer, set the proxy information in your custom resource (CR) file as shown in the following example: | |||
| * As a developer, set the proxy information in your `{product-custom-resource-type}` CR file as shown in the following example: | |||
There was a problem hiding this comment.
Suggested change
| * As a developer, set the proxy information in your `{product-custom-resource-type}` CR file as shown in the following example: | |
| * As a developer, set the proxy information in your custom `{product-custom-resource-type}` custom resource as shown in the following example: |
themr0c
reviewed
Jan 20, 2025
| @@ -13,7 +13,7 @@ To use the {product-short} operator to run {product} with your custom configurat | |||
|
|
|||
| .Procedure | |||
|
|
|||
| . Author your {product-custom-resource-type} custom resource in a `{my-product-cr-name}.yaml` file to use your custom config maps and secrets. | |||
| . Author your {product-custom-resource-type} CR in a `{my-product-cr-name}.yaml` file to use your custom config maps and secrets. | |||
There was a problem hiding this comment.
Suggested change
| . Author your {product-custom-resource-type} CR in a `{my-product-cr-name}.yaml` file to use your custom config maps and secrets. | |
| . Author your `{product-custom-resource-type}` custom resource in a `{my-product-cr-name}.yaml` file to use your custom config maps and secrets. |
themr0c
reviewed
Jan 20, 2025
| @@ -82,7 +82,7 @@ kubectl patch serviceaccount default \ | |||
| ---- | |||
| -- | |||
|
|
|||
| . Create a Custom Resource file using the following template: | |||
| . Create a custom resource file using the following template: | |||
There was a problem hiding this comment.
Suggested change
| . Create a custom resource file using the following template: | |
| . Create your `{product-custom-resource-type}` custom resource using the following template: |
themr0c
reviewed
Jan 20, 2025
| @@ -33,7 +33,7 @@ data: | |||
| disabled: false | |||
| ---- | |||
|
|
|||
| . Set the value of the `dynamicPluginsConfigMapName` parameter to the name of the ConfigMap file in your `Backstage` custom resource: | |||
| . Set the value of the `dynamicPluginsConfigMapName` parameter to the name of the ConfigMap file in your `{product-custom-resource-type}` custom resource: | |||
There was a problem hiding this comment.
Suggested change
| . Set the value of the `dynamicPluginsConfigMapName` parameter to the name of the ConfigMap file in your `{product-custom-resource-type}` custom resource: | |
| . Set the value of the `dynamicPluginsConfigMapName` parameter to the name of your `dynamic-plugins-rhdh` config map in your `{product-custom-resource-type}` custom resource: |
themr0c
reviewed
Jan 20, 2025
| @@ -33,7 +33,7 @@ data: | |||
| disabled: true | |||
| ---- | |||
|
|
|||
| . Set the value of the `dynamicPluginsConfigMapName` parameter to the name of the ConfigMap file in your `Backstage` custom resource: | |||
| . Set the value of the `dynamicPluginsConfigMapName` parameter to the name of the ConfigMap file in your `{product-custom-resource-type}` custom resource: | |||
There was a problem hiding this comment.
Suggested change
| . Set the value of the `dynamicPluginsConfigMapName` parameter to the name of the ConfigMap file in your `{product-custom-resource-type}` custom resource: | |
| . Set the value of the `dynamicPluginsConfigMapName` parameter to the name of your `dynamic-plugins-rhdh` config map in your `{product-custom-resource-type}` custom resource: |
themr0c
reviewed
Jan 20, 2025
| @@ -41,7 +41,7 @@ spec: | |||
| - port: http-metrics | |||
| path: '/metrics' | |||
| ---- | |||
| <1> Replace `<custom_resource_name>` with the name of your {product} CR. | |||
| <1> Replace `<custom_resource_name>` with the name of your `{product-custom-resource-type}` CR. | |||
There was a problem hiding this comment.
Suggested change
| <1> Replace `<custom_resource_name>` with the name of your `{product-custom-resource-type}` CR. | |
| <1> Replace `<custom_resource_name>` with the name of your `{product-custom-resource-type}` custom resource. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
IMPORTANT: Do Not Merge - To be merged by Docs Team Only
Version(s):
1.4, main
Add the relevant labels to the Pull Request.
Issue:
RHIDP-5374