Skip to content

Conversation

@themr0c
Copy link
Member

@themr0c themr0c commented Nov 19, 2024

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:

  • We miss a complete reference for the app-config.yaml file fields.
  • We need new procedures explaining how to do the first deployment with the correct configuration, rather than reconfiguring a previously deployed rhdh instance.
  • The existing procedures should be reworked to make clear it is about reconfiguring a rhdh instance not using the config maps.
  • Configuring the proxy by using the operator is a specific used case of configuring the deployment by using the operator.
  • Leftovers in Getting Started require attention.

@rhdh-bot
Copy link
Collaborator

rhdh-bot commented Nov 19, 2024

@themr0c
Copy link
Member Author

themr0c commented Dec 16, 2024

@kadel @gazarenkov Can you give your formal approval?

@themr0c
Copy link
Member Author

themr0c commented Dec 16, 2024

/cherry-pick release-1.4

@openshift-cherrypick-robot
Copy link
Contributor

@themr0c: once the present PR merges, I will cherry-pick it on top of release-1.4 in a new PR and assign it to you.

In response to this:

/cherry-pick release-1.4

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 themr0c merged commit 00097b4 into redhat-developer:main Dec 16, 2024
3 checks passed
@openshift-cherrypick-robot
Copy link
Contributor

@themr0c: #721 failed to apply on top of branch "release-1.4":

Applying: RHIDP-4929 Moving content to dedicated titles for the Configure category
Applying: Update titles/configuring/master.adoc
Applying: moving procedures on @kadel suggestion
Applying: fix build
Applying: reformulate for clarity
Applying: reformulate for clarity
Applying: Added app.branding
Applying: Update assemblies/assembly-configuring-techdocs.adoc
Applying: Update assemblies/assembly-customizing-the-appearance.adoc
Applying: Update modules/configuring/proc-provisioning-your-custom-configuration.adoc
Applying: Update modules/configuring/proc-registering-your-custom-configuration-by-using-the-operator.adoc
Applying: Update modules/configuring/proc-registering-your-custom-configuration-by-using-the-operator.adoc
Applying: Update modules/configuring/proc-adding-custom-configuration-files-by-using-the-operator.adoc
Applying: docs: implemented suggestions
Applying: Apply suggestions from code review
Applying: Update modules/configuring-deployment/proc-configuring-deployment-by-using-the-operator.adoc
Applying: Update modules/configuring/proc-provisioning-your-custom-configuration.adoc
Applying: added product-custom-resource-type attribute
Using index info to reconstruct a base tree...
M	artifacts/attributes.adoc
Falling back to patching base and 3-way merge...
Auto-merging artifacts/attributes.adoc
CONFLICT (content): Merge conflict in artifacts/attributes.adoc
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
hint: When you have resolved this problem, run "git am --continue".
hint: If you prefer to skip this patch, run "git am --skip" instead.
hint: To restore the original branch and stop patching, run "git am --abort".
hint: Disable this message with "git config advice.mergeConflict false"
Patch failed at 0018 added product-custom-resource-type attribute

In response to this:

/cherry-pick release-1.4

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 added a commit to themr0c/red-hat-developers-documentation-rhdh that referenced this pull request Dec 16, 2024
…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]>
Gerry-Forde pushed a commit that referenced this pull request Dec 16, 2024
…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]
Copy link
Member

@rm3l rm3l Dec 16, 2024

Choose a reason for hiding this comment

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

@themr0c Curious why this was removed? Is this intentional? This was added in #709 to clarify how the NO_PROXY env var is handled in RHDH, as a follow-up to a few customer issues.

Copy link
Member Author

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

Gerry-Forde pushed a commit to Gerry-Forde/red-hat-developers-documentation-rhdh-v2 that referenced this pull request Dec 16, 2024
…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]>
@themr0c themr0c deleted the RHIDP-4929 branch December 17, 2024 10:52
otikhomi pushed a commit to otikhomi/red-hat-developers-documentation-rhdh that referenced this pull request Jan 20, 2025
…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]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Peer review done 📘 Technical review done ⛅ Any procedure has been succesfully tested

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants