-
Task
-
Resolution: Unresolved
-
Major
-
None
-
1.4
-
3
-
False
-
-
False
-
-
The entire documentation is not consistent in the way it mentions editing the user custom `app-config.yaml` application configuration file, located in the user custom config map.
The file name is not always the same.
The config map name is not always the same, when it is mentionned.
Since we have now the Configuring title, and attributes such as :my-app-config-config-map: my-rhdh-app-config :my-app-config-file: app-config.yaml, it is time to update the existing doc set:
For minimalism and consistency,
- Only mention the configuration file.
- Always use the attribute to mention the file name.
- Always link to the Configuring title where the user can understand how to create, upload and use the configuration file.
- Do not mention the config map (the link to Configuring is sufficient)
Replace all variants of mentions such as:
your custom Developer Hub ConfigMap, such as app-config-rhdh, and add following code to the app-config.yaml content
Rather always use:
In prerequisites:
* You link:{configuring-book-url}[added a custom {product-short} application configuration], and have sufficient permissions to modify it.
In a procedure step:
link:{configuring-book-url}[edit your custom `{my-app-config-file}` {product-short} configuration file]
- split to
-
RHIDP-5436 Consistent mentions to the application configuration file in Customizing
- In Progress