-
Notifications
You must be signed in to change notification settings - Fork 57
RHIDP-4929 /RHIDP-4930 Moving content to Configuring and Customizing titles #721
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
Conversation
|
Updated preview: https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/pr-721/ @ 12/16/24 09:32:27 |
use attributes
Signed-off-by: Fabrice Flore-Thébault <[email protected]>
Signed-off-by: Fabrice Flore-Thébault <[email protected]>
Signed-off-by: Fabrice Flore-Thébault <[email protected]>
|
@kadel @gazarenkov Can you give your formal approval? |
|
/cherry-pick release-1.4 |
|
@themr0c: once the present PR merges, I will cherry-pick it on top of In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
|
@themr0c: #721 failed to apply on top of branch "release-1.4": In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
…titles (redhat-developer#721) * RHIDP-4929 Moving content to dedicated titles for the Configure category Signed-off-by: Fabrice Flore-Thébault <[email protected]> * Update titles/configuring/master.adoc * moving procedures on @kadel suggestion Signed-off-by: Fabrice Flore-Thébault <[email protected]> * fix build Signed-off-by: Fabrice Flore-Thébault <[email protected]> * reformulate for clarity Signed-off-by: Fabrice Flore-Thébault <[email protected]> * reformulate for clarity Signed-off-by: Fabrice Flore-Thébault <[email protected]> * Added app.branding Signed-off-by: Fabrice Flore-Thébault <[email protected]> * Update assemblies/assembly-configuring-techdocs.adoc * Update assemblies/assembly-customizing-the-appearance.adoc * Update modules/configuring/proc-provisioning-your-custom-configuration.adoc * Update modules/configuring/proc-registering-your-custom-configuration-by-using-the-operator.adoc * Update modules/configuring/proc-registering-your-custom-configuration-by-using-the-operator.adoc * Update modules/configuring/proc-adding-custom-configuration-files-by-using-the-operator.adoc * docs: implemented suggestions Signed-off-by: Fabrice Flore-Thébault <[email protected]> * Apply suggestions from code review * Update modules/configuring-deployment/proc-configuring-deployment-by-using-the-operator.adoc * Update modules/configuring/proc-provisioning-your-custom-configuration.adoc * added product-custom-resource-type attribute Signed-off-by: Fabrice Flore-Thébault <[email protected]> * v1alpha1 is deprecated, use v1alpha3 Signed-off-by: Fabrice Flore-Thébault <[email protected]> * removed redundant procedure Signed-off-by: Fabrice Flore-Thébault <[email protected]> * towards more clarity Signed-off-by: Fabrice Flore-Thébault <[email protected]> * consistent names for database secrets Signed-off-by: Fabrice Flore-Thébault <[email protected]> * added cross-title links Signed-off-by: Fabrice Flore-Thébault <[email protected]> * misc fixes Signed-off-by: Fabrice Flore-Thébault <[email protected]> * misc fixes Signed-off-by: Fabrice Flore-Thébault <[email protected]> * clarity regarding mandatory vs. optional fields, work on vocabulary Signed-off-by: Fabrice Flore-Thébault <[email protected]> * Apply suggestions from code review * Apply suggestions from code review use attributes * Update artifacts/attributes.adoc * applied suggestions Signed-off-by: Fabrice Flore-Thébault <[email protected]> * fix typo Signed-off-by: Fabrice Flore-Thébault <[email protected]> * fix broken links, use attributes Signed-off-by: Fabrice Flore-Thébault <[email protected]> * Update modules/customizing/proc-customizing-your-product-title.adoc * Update assemblies/assembly-customizing-the-appearance.adoc * Delete modules/customizing-the-appearance/proc-customize-rhdh-tab-tooltip.adoc --------- Signed-off-by: Fabrice Flore-Thébault <[email protected]>
…titles (#721) (#798) * RHIDP-4929 Moving content to dedicated titles for the Configure category * Update titles/configuring/master.adoc * moving procedures on @kadel suggestion * fix build * reformulate for clarity * reformulate for clarity * Added app.branding * Update assemblies/assembly-configuring-techdocs.adoc * Update assemblies/assembly-customizing-the-appearance.adoc * Update modules/configuring/proc-provisioning-your-custom-configuration.adoc * Update modules/configuring/proc-registering-your-custom-configuration-by-using-the-operator.adoc * Update modules/configuring/proc-registering-your-custom-configuration-by-using-the-operator.adoc * Update modules/configuring/proc-adding-custom-configuration-files-by-using-the-operator.adoc * docs: implemented suggestions * Apply suggestions from code review * Update modules/configuring-deployment/proc-configuring-deployment-by-using-the-operator.adoc * Update modules/configuring/proc-provisioning-your-custom-configuration.adoc * added product-custom-resource-type attribute * v1alpha1 is deprecated, use v1alpha3 * removed redundant procedure * towards more clarity * consistent names for database secrets * added cross-title links * misc fixes * misc fixes * clarity regarding mandatory vs. optional fields, work on vocabulary * Apply suggestions from code review * Apply suggestions from code review use attributes * Update artifacts/attributes.adoc * applied suggestions * fix typo * fix broken links, use attributes * Update modules/customizing/proc-customizing-your-product-title.adoc * Update assemblies/assembly-customizing-the-appearance.adoc * Delete modules/customizing-the-appearance/proc-customize-rhdh-tab-tooltip.adoc --------- Signed-off-by: Fabrice Flore-Thébault <[email protected]>
| @@ -8,7 +12,8 @@ You can run the {product-very-short} application behind a corporate proxy by set | |||
| Additionally, set the `NO_PROXY` environment variable to bypass the proxy for certain domains. The variable value is a comma-separated list of hostnames or IP addresses that can be accessed without the proxy, even if one is specified. | |||
|
|
|||
| include::modules/admin/procedure-understanding-no-proxy.adoc[leveloffset=+1] | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
My mistake. Lost in rebase. Restoring it: #811
…titles (redhat-developer#721) * RHIDP-4929 Moving content to dedicated titles for the Configure category Signed-off-by: Fabrice Flore-Thébault <[email protected]> * Update titles/configuring/master.adoc * moving procedures on @kadel suggestion Signed-off-by: Fabrice Flore-Thébault <[email protected]> * fix build Signed-off-by: Fabrice Flore-Thébault <[email protected]> * reformulate for clarity Signed-off-by: Fabrice Flore-Thébault <[email protected]> * reformulate for clarity Signed-off-by: Fabrice Flore-Thébault <[email protected]> * Added app.branding Signed-off-by: Fabrice Flore-Thébault <[email protected]> * Update assemblies/assembly-configuring-techdocs.adoc * Update assemblies/assembly-customizing-the-appearance.adoc * Update modules/configuring/proc-provisioning-your-custom-configuration.adoc * Update modules/configuring/proc-registering-your-custom-configuration-by-using-the-operator.adoc * Update modules/configuring/proc-registering-your-custom-configuration-by-using-the-operator.adoc * Update modules/configuring/proc-adding-custom-configuration-files-by-using-the-operator.adoc * docs: implemented suggestions Signed-off-by: Fabrice Flore-Thébault <[email protected]> * Apply suggestions from code review * Update modules/configuring-deployment/proc-configuring-deployment-by-using-the-operator.adoc * Update modules/configuring/proc-provisioning-your-custom-configuration.adoc * added product-custom-resource-type attribute Signed-off-by: Fabrice Flore-Thébault <[email protected]> * v1alpha1 is deprecated, use v1alpha3 Signed-off-by: Fabrice Flore-Thébault <[email protected]> * removed redundant procedure Signed-off-by: Fabrice Flore-Thébault <[email protected]> * towards more clarity Signed-off-by: Fabrice Flore-Thébault <[email protected]> * consistent names for database secrets Signed-off-by: Fabrice Flore-Thébault <[email protected]> * added cross-title links Signed-off-by: Fabrice Flore-Thébault <[email protected]> * misc fixes Signed-off-by: Fabrice Flore-Thébault <[email protected]> * misc fixes Signed-off-by: Fabrice Flore-Thébault <[email protected]> * clarity regarding mandatory vs. optional fields, work on vocabulary Signed-off-by: Fabrice Flore-Thébault <[email protected]> * Apply suggestions from code review * Apply suggestions from code review use attributes * Update artifacts/attributes.adoc * applied suggestions Signed-off-by: Fabrice Flore-Thébault <[email protected]> * fix typo Signed-off-by: Fabrice Flore-Thébault <[email protected]> * fix broken links, use attributes Signed-off-by: Fabrice Flore-Thébault <[email protected]> * Update modules/customizing/proc-customizing-your-product-title.adoc * Update assemblies/assembly-customizing-the-appearance.adoc * Delete modules/customizing-the-appearance/proc-customize-rhdh-tab-tooltip.adoc --------- Signed-off-by: Fabrice Flore-Thébault <[email protected]>
…titles (redhat-developer#721) * RHIDP-4929 Moving content to dedicated titles for the Configure category Signed-off-by: Fabrice Flore-Thébault <[email protected]> * Update titles/configuring/master.adoc * moving procedures on @kadel suggestion Signed-off-by: Fabrice Flore-Thébault <[email protected]> * fix build Signed-off-by: Fabrice Flore-Thébault <[email protected]> * reformulate for clarity Signed-off-by: Fabrice Flore-Thébault <[email protected]> * reformulate for clarity Signed-off-by: Fabrice Flore-Thébault <[email protected]> * Added app.branding Signed-off-by: Fabrice Flore-Thébault <[email protected]> * Update assemblies/assembly-configuring-techdocs.adoc * Update assemblies/assembly-customizing-the-appearance.adoc * Update modules/configuring/proc-provisioning-your-custom-configuration.adoc * Update modules/configuring/proc-registering-your-custom-configuration-by-using-the-operator.adoc * Update modules/configuring/proc-registering-your-custom-configuration-by-using-the-operator.adoc * Update modules/configuring/proc-adding-custom-configuration-files-by-using-the-operator.adoc * docs: implemented suggestions Signed-off-by: Fabrice Flore-Thébault <[email protected]> * Apply suggestions from code review * Update modules/configuring-deployment/proc-configuring-deployment-by-using-the-operator.adoc * Update modules/configuring/proc-provisioning-your-custom-configuration.adoc * added product-custom-resource-type attribute Signed-off-by: Fabrice Flore-Thébault <[email protected]> * v1alpha1 is deprecated, use v1alpha3 Signed-off-by: Fabrice Flore-Thébault <[email protected]> * removed redundant procedure Signed-off-by: Fabrice Flore-Thébault <[email protected]> * towards more clarity Signed-off-by: Fabrice Flore-Thébault <[email protected]> * consistent names for database secrets Signed-off-by: Fabrice Flore-Thébault <[email protected]> * added cross-title links Signed-off-by: Fabrice Flore-Thébault <[email protected]> * misc fixes Signed-off-by: Fabrice Flore-Thébault <[email protected]> * misc fixes Signed-off-by: Fabrice Flore-Thébault <[email protected]> * clarity regarding mandatory vs. optional fields, work on vocabulary Signed-off-by: Fabrice Flore-Thébault <[email protected]> * Apply suggestions from code review * Apply suggestions from code review use attributes * Update artifacts/attributes.adoc * applied suggestions Signed-off-by: Fabrice Flore-Thébault <[email protected]> * fix typo Signed-off-by: Fabrice Flore-Thébault <[email protected]> * fix broken links, use attributes Signed-off-by: Fabrice Flore-Thébault <[email protected]> * Update modules/customizing/proc-customizing-your-product-title.adoc * Update assemblies/assembly-customizing-the-appearance.adoc * Delete modules/customizing-the-appearance/proc-customize-rhdh-tab-tooltip.adoc --------- Signed-off-by: Fabrice Flore-Thébault <[email protected]>
Created these new titles to populate the Configure category, and populated them with content from the Admin guide and the Getting started guide:
Configuring: https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/pr-721/configuring/
Customizing: https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/pr-721/customizing/
Moved remaining sections from the Getting started guide to https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/pr-721/plugins-rhdh-configure/
Removed empty titles: Admin guide, Getting started guide.
Work on consistency: rewritten some titles and metadata, renamed some files, added missing symbolic links.
Rewritten "Provisioning your custom configuration" to be technically accurate, and promoting clearly the idea that the user should provision and register configuration files before deploying.
IMPORTANT: Do Not Merge - To be merged by Docs Team Only
Version(s): 1.3.x, 1.4
Add the relevant labels to the Pull Request.
Issue: https://issues.redhat.com/browse/RHIDP-4929 https://issues.redhat.com/browse/RHIDP-4930
Note that, the scope of this pull request being already too big, some things are left rough:
app-config.yamlfile fields.