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

[pabel-rh]

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]

Updated preview: https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/pr-842/ @ 01/16/25 06:46:03

[linfraze]

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

[linfraze]

It looks like the module you are trying to link to is not in the Installing on OCP title, but rather in the Configuring title. Since we are already in the Configuring title, you should be able to link with an internal xref. Try the folloiwng:

Suggested change

	. In {ocp-short}, author your ConfigMap or Secret custom resource in a YAML file. For more information, see link:{installing-on-ocp-book-url}#provisioning-your-custom-configuration[].
	. In {ocp-short}, author your ConfigMap or Secret custom resource in a YAML file. For more information, see xref:provisioning-your-custom-configuration[Provisioning and using your custom {product} configuration].

[linfraze]

I wonder if "author" is the best word in this context. Maybe "configure"? No change, just something to consider and to ensure we are writing consistently across the docs.

[pabel-rh]

I see! Thanks so much for the help with the Cross references, Lindsey. I'll keep that in mind.
Yes, I also found "author" a bit odd. I went with your suggestion and I found a mention of this in another doc:
https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.4/html/telemetry_data_collection/assembly-rhdh-telemetry#proc-enabling-telemetry-using-operator_title-telemetry

It says, "Create xyz ConfigMap with the following YAML code"...

[linfraze]

Suggested change

	. Declare the ConfigMap or Secret file in your `{product-custom-resource-type}` custom resource.
	. Declare the ConfigMap or Secret file in your `{product-custom-resource-type}` custom resource. For example:

[linfraze]

Is Declare the right word? Maybe. But the linter for 8th grade language might flag it and suggest that a simpler word can be used.

[pabel-rh]

I don't think so either. I rewrote it as per the text I found here:
https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.4/html/telemetry_data_collection/assembly-rhdh-telemetry#proc-enabling-telemetry-using-operator_title-telemetry

But I am a little doubtful about the accuracy of 'configMaps name' and 'secrets name'. Also, I feel the line - "Set the value of the 'configMaps name' or 'secrets name' to the name of the ConfigMap or Secret file......." could be slightly confusing. Would it be a good idea to split this into two separate lines, by saying, "Set the value of the 'configMaps name' to the name of the ConfigMap file or the 'secrets name' to the name of the Secret file in your {product-custom-resource-type} CR." ?

[pabel-rh]

@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?

[gazarenkov]

name: {my-product-configmap}

[pabel-rh]

There's a slight change in the attributes. I've changed it to {my-app-config-config-map} which displays "my-rhdh-app-config".

[gazarenkov]

name: {my-product-configmap}