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

RHIDP-4780: Document per-ConfigMap/Secret configuration of mountPath #842

Open
wants to merge 7 commits into
base: release-1.4
Choose a base branch
from

Conversation

pabel-rh
Copy link
Contributor

@pabel-rh pabel-rh commented Jan 13, 2025

IMPORTANT: Do Not Merge - To be merged by Docs Team Only

Version(s): 1.4.x, main
Issue: RHIDP-4780
**Preview link:**https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/pr-842/configuring/#mounting-additional-files-in-your-custom-configuration-using-rhdh-operator

(This is showing the new procedure as Chapter 2, but it's supposed to be under 1.2. So, technically, as Chapter 1.2.1.. I've made the correction in the second commit but for some reason it isn't reflecting in the preview link)

@rhdh-bot
Copy link
Collaborator

rhdh-bot commented Jan 13, 2025

Copy link
Member

@linfraze linfraze left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This content is a great addition to the docs. A few comments.

@pabel-rh
Copy link
Contributor Author

@linfraze @jmagak , thank you so much for your valuable reviews. I have incorporated your comments.
@linfraze , for one of the comments you've provided, I've requested your suggestions on the alternate text. Would you please take a look?

Copy link
Member

@linfraze linfraze left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

a couple new comments but looking good!

====
For more information, see xref:provisioning-your-custom-configuration[Provisioning and using your custom {product} configuration].

. Set the value of the `configMaps name` to the name of the config map or `secrets name` to the name of the secret file in your `{product-custom-resource-type}` CR. For example:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is must clearer - thank you! The only comment I have is that Kubernetes formats these objects as ConfigMap and Secret (capitalized that way) so we should do the same in our docs. Please forgive me for not noticing that earlier!

Suggested change
. Set the value of the `configMaps name` to the name of the config map or `secrets name` to the name of the secret file in your `{product-custom-resource-type}` CR. For example:
. Set the value of the `configMaps name` to the name of the ConfigMap or `secrets name` to the name of the Secret in your `{product-custom-resource-type}` CR. For example:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants