RHIDP-5372- Fix inconsistent reference to the app config file #914
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
jmagak
added
Peer review needed 📖
do-no-merge/review-in-progress 👀
Technical review needed 🔩
|
Updated preview: https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/pr-914/ @ 02/24/25 10:21:38 |
jmagak
force-pushed
the
RHIDP-5372-Consistency-for-references-to-the-application-configuration-file
branch
from
299460e to
ffd3df6
Compare
linfraze
reviewed
Feb 10, 2025
There was a problem hiding this comment.
Is app-config.yaml truly the most clear and accurate way to refer to this file? Is it always named that? Can a user change it? Something to consider.
There is also an ongoing conversation in the decision log on this topic.
| @@ -15,7 +15,7 @@ You can add an existing template to your {product} instance by using the Catalog | |||
|
|
|||
| .Procedure | |||
|
|
|||
| * In the `app-config.yaml` configuration file, modify the `catalog.rules` section to include a rule for templates, and configure the `catalog.locations` section to point to the template that you want to add, as shown in the following example: | |||
There was a problem hiding this comment.
I wonder if we should refer to this file by type and not by a (configurable) file name. We know the user has an app configuration file, but we don't necessarily know if it is called app-config.yaml.
This OCP doc refers to the main app configuration file
jmagak
force-pushed
the
RHIDP-5372-Consistency-for-references-to-the-application-configuration-file
branch
from
ffd3df6 to
70bb248
Compare
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.3, 1.4, 1.5
Add the relevant labels to the Pull Request.
Issue: https://issues.redhat.com/browse/RHIDP-5372