RHIDP-5881: Fix inconsistencies with referencing my-rhdh-secrets by jmagak · Pull Request #944 · redhat-developer/red-hat-developers-documentation-rhdh

jmagak · 2025-02-19T13:06:41Z

IMPORTANT: Do Not Merge - To be merged by Docs Team Only

Version(s): 1.4, 1.5

Add the relevant labels to the Pull Request.
Issue: https://issues.redhat.com/browse/RHIDP-5881

Preview: https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/pr-944/

rhdh-bot · 2025-02-19T13:09:09Z

Updated preview: https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/pr-944/ @ 03/20/25 15:53:34

modules/installation/proc-deploy-rhdh-instance-gke.adoc

linfraze

A few questions and comments

...iguring/proc-mounting-additional-files-in-your-custom-configuration-using-rhdh-operator.adoc

modules/configuring/proc-provisioning-your-custom-configuration.adoc

modules/installation/proc-configuring-an-rhdh-instance-with-tls-in-kubernetes.adoc

modules/installation/proc-deploy-rhdh-instance-gke.adoc

linfraze

Good stuff here, just make sure we are complying with the guidelines for variables and definitions.

https://redhat-documentation.github.io/supplementary-style-guide/#user-replaced-values

https://github.com/openshift/openshift-docs/blob/main/contributing_to_docs/doc_guidelines.adoc#callouts-in-code-blocks

https://www.ibm.com/docs/en/ibm_style/pdf/ibm-style-documentation.pdf

...iguring/proc-mounting-additional-files-in-your-custom-configuration-using-rhdh-operator.adoc

modules/configuring/proc-provisioning-your-custom-configuration.adoc

modules/configuring/proc-using-the-operator-to-run-rhdh-with-your-custom-configuration.adoc

modules/installation/proc-deploy-rhdh-instance-eks.adoc

Fix inconsistencies with referencing my-rhdh-secrets Fix inconsistencies with referencing my-rhdh-secrets Fix inconsistencies with referencing my-rhdh-secrets Fix inconsistencies with referencing my-rhdh-secrets Fix inconsistencies with referencing my-rhdh-secrets Fix inconsistencies with referencing my-rhdh-secrets

linfraze

Some optional formatting corrections:

I think it is important to fix the format of the example on line 43, but it appears to be a pre-existing formatting error and is therefore outside the scope of this PR. Let's open a new ticket / PR to fix the format of the ConfigMap and Secret examples in step 1.
I recommend defining variables as shown in the OCP guidelines rather than using a NOTES admonition.
There are instances in which we are using a variable where a variable isn't needed / doesn't add value or clarity for the user. It isn't doing harm, but we might consider whether the variable is being used in the right context throughout the docs.

modules/configuring/proc-provisioning-your-custom-configuration.adoc

modules/configuring/proc-using-the-operator-to-run-rhdh-with-your-custom-configuration.adoc

modules/installation/proc-deploy-rhdh-instance-eks.adoc

...iguring/proc-mounting-additional-files-in-your-custom-configuration-using-rhdh-operator.adoc

hmanwani-rh · 2025-03-21T10:30:13Z

/cherry-pick release-1.4

openshift-cherrypick-robot · 2025-03-21T10:30:16Z

@hmanwani-rh: 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.

Details

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.

hmanwani-rh · 2025-03-21T10:30:23Z

/cherry-pick release-1.5

openshift-cherrypick-robot · 2025-03-21T10:30:25Z

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

Details

In response to this:

/cherry-pick release-1.5

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.

openshift-cherrypick-robot · 2025-03-21T10:31:06Z

@hmanwani-rh: #944 failed to apply on top of branch "release-1.4":

Applying: Fix inconsistencies with referencing my-rhdh-secrets
Using index info to reconstruct a base tree...
M	modules/configuring/proc-mounting-additional-files-in-your-custom-configuration-using-rhdh-operator.adoc
M	modules/configuring/proc-provisioning-your-custom-configuration.adoc
M	modules/configuring/proc-using-the-operator-to-run-rhdh-with-your-custom-configuration.adoc
M	modules/dynamic-plugins/proc-config-dynamic-plugins-rhdh-operator.adoc
M	modules/installation/proc-configuring-an-rhdh-instance-with-tls-in-kubernetes.adoc
M	modules/installation/proc-deploy-rhdh-instance-gke.adoc
M	modules/installation/proc-rhdh-deploy-aks-operator.adoc
Falling back to patching base and 3-way merge...
Auto-merging modules/installation/proc-rhdh-deploy-aks-operator.adoc
CONFLICT (content): Merge conflict in modules/installation/proc-rhdh-deploy-aks-operator.adoc
Auto-merging modules/installation/proc-deploy-rhdh-instance-gke.adoc
CONFLICT (content): Merge conflict in modules/installation/proc-deploy-rhdh-instance-gke.adoc
Auto-merging modules/installation/proc-configuring-an-rhdh-instance-with-tls-in-kubernetes.adoc
CONFLICT (content): Merge conflict in modules/installation/proc-configuring-an-rhdh-instance-with-tls-in-kubernetes.adoc
Auto-merging modules/dynamic-plugins/proc-config-dynamic-plugins-rhdh-operator.adoc
CONFLICT (content): Merge conflict in modules/dynamic-plugins/proc-config-dynamic-plugins-rhdh-operator.adoc
Auto-merging modules/configuring/proc-using-the-operator-to-run-rhdh-with-your-custom-configuration.adoc
Auto-merging modules/configuring/proc-provisioning-your-custom-configuration.adoc
Auto-merging modules/configuring/proc-mounting-additional-files-in-your-custom-configuration-using-rhdh-operator.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 0001 Fix inconsistencies with referencing my-rhdh-secrets

Details

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.

openshift-cherrypick-robot · 2025-03-21T10:31:40Z

@hmanwani-rh: #944 failed to apply on top of branch "release-1.5":

Applying: Fix inconsistencies with referencing my-rhdh-secrets
Using index info to reconstruct a base tree...
M	modules/dynamic-plugins/proc-config-dynamic-plugins-rhdh-operator.adoc
M	modules/installation/proc-configuring-an-rhdh-instance-with-tls-in-kubernetes.adoc
M	modules/installation/proc-deploy-rhdh-instance-gke.adoc
M	modules/installation/proc-rhdh-deploy-aks-operator.adoc
Falling back to patching base and 3-way merge...
Auto-merging modules/installation/proc-rhdh-deploy-aks-operator.adoc
CONFLICT (content): Merge conflict in modules/installation/proc-rhdh-deploy-aks-operator.adoc
Auto-merging modules/installation/proc-deploy-rhdh-instance-gke.adoc
CONFLICT (content): Merge conflict in modules/installation/proc-deploy-rhdh-instance-gke.adoc
Auto-merging modules/installation/proc-configuring-an-rhdh-instance-with-tls-in-kubernetes.adoc
CONFLICT (content): Merge conflict in modules/installation/proc-configuring-an-rhdh-instance-with-tls-in-kubernetes.adoc
Auto-merging modules/dynamic-plugins/proc-config-dynamic-plugins-rhdh-operator.adoc
CONFLICT (content): Merge conflict in modules/dynamic-plugins/proc-config-dynamic-plugins-rhdh-operator.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 0001 Fix inconsistencies with referencing my-rhdh-secrets

Details

In response to this:

/cherry-pick release-1.5

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.

jmagak requested a review from Gerry-Forde February 19, 2025 13:06

jmagak temporarily deployed to external February 19, 2025 13:06 — with GitHub Actions Inactive

jmagak added Peer review needed 📖 do-no-merge/review-in-progress 👀 labels Feb 19, 2025

jmagak changed the title ~~Fix inconsistencies with referencing my-rhdh-secrets~~ RHIDP-5881: Fix inconsistencies with referencing my-rhdh-secrets Feb 19, 2025

Gerry-Forde reviewed Feb 20, 2025

View reviewed changes

modules/installation/proc-deploy-rhdh-instance-gke.adoc Outdated Show resolved Hide resolved

jmagak temporarily deployed to external February 20, 2025 13:22 — with GitHub Actions Inactive

jmagak temporarily deployed to external February 20, 2025 13:44 — with GitHub Actions Inactive

linfraze reviewed Feb 24, 2025

View reviewed changes

linfraze added Peer review done 📘 and removed Peer review needed 📖 labels Feb 24, 2025

jmagak force-pushed the RHIDP-5881-Consistency-for-references-to-the-my-rhdh-secrets branch from 629557b to b4f1923 Compare February 28, 2025 06:46

jmagak temporarily deployed to external February 28, 2025 06:46 — with GitHub Actions Inactive

jmagak force-pushed the RHIDP-5881-Consistency-for-references-to-the-my-rhdh-secrets branch from b4f1923 to 9d51de9 Compare February 28, 2025 12:22

jmagak temporarily deployed to external February 28, 2025 12:22 — with GitHub Actions Inactive

jmagak temporarily deployed to external February 28, 2025 12:23 — with GitHub Actions Inactive

jmagak requested a review from nickboldt February 28, 2025 12:31

jmagak force-pushed the RHIDP-5881-Consistency-for-references-to-the-my-rhdh-secrets branch from 4c61e64 to de56c04 Compare March 6, 2025 13:59

jmagak temporarily deployed to external March 6, 2025 13:59 — with GitHub Actions Inactive

jmagak force-pushed the RHIDP-5881-Consistency-for-references-to-the-my-rhdh-secrets branch from de56c04 to 40c1839 Compare March 10, 2025 18:30

jmagak temporarily deployed to external March 10, 2025 18:30 — with GitHub Actions Inactive

jmagak force-pushed the RHIDP-5881-Consistency-for-references-to-the-my-rhdh-secrets branch from 40c1839 to 6d4281e Compare March 13, 2025 10:09

jmagak temporarily deployed to external March 13, 2025 10:09 — with GitHub Actions Inactive

jmagak force-pushed the RHIDP-5881-Consistency-for-references-to-the-my-rhdh-secrets branch from 6d4281e to a40de7f Compare March 13, 2025 11:31

jmagak temporarily deployed to external March 13, 2025 11:31 — with GitHub Actions Inactive

jmagak added Peer review needed 📖 and removed Peer review done 📘 labels Mar 13, 2025

jmagak force-pushed the RHIDP-5881-Consistency-for-references-to-the-my-rhdh-secrets branch from a40de7f to 62908ce Compare March 13, 2025 11:35

jmagak temporarily deployed to external March 13, 2025 11:36 — with GitHub Actions Inactive

jmagak temporarily deployed to external March 14, 2025 13:03 — with GitHub Actions Inactive

jmagak requested a review from themr0c March 14, 2025 13:03

linfraze reviewed Mar 18, 2025

View reviewed changes

jmagak force-pushed the RHIDP-5881-Consistency-for-references-to-the-my-rhdh-secrets branch from c09e048 to cab7f7f Compare March 20, 2025 09:06

jmagak temporarily deployed to external March 20, 2025 09:06 — with GitHub Actions Inactive

GitHub Actions added 2 commits March 20, 2025 12:02

Fix inconsistencies with referencing my-rhdh-secrets

491fe88

jmagak force-pushed the RHIDP-5881-Consistency-for-references-to-the-my-rhdh-secrets branch from cab7f7f to 491fe88 Compare March 20, 2025 11:02

jmagak temporarily deployed to external March 20, 2025 11:02 — with GitHub Actions Inactive

Apply peer suggestions

131970f

jmagak temporarily deployed to external March 20, 2025 11:40 — with GitHub Actions Inactive

Apply peer suggestions

428c075

jmagak temporarily deployed to external March 20, 2025 12:43 — with GitHub Actions Inactive

linfraze approved these changes Mar 20, 2025

View reviewed changes

Apply peer suggestions

a4bd230

jmagak temporarily deployed to external March 20, 2025 15:47 — with GitHub Actions Inactive

Apply peer suggestions

e775dd1

jmagak temporarily deployed to external March 20, 2025 15:51 — with GitHub Actions Inactive

jmagak added Ready to merge 💂 Peer review done 📘 and removed Peer review needed 📖 do-no-merge/review-in-progress 👀 Peer review done 📘 labels Mar 20, 2025

hmanwani-rh merged commit e04c251 into redhat-developer:main Mar 21, 2025
3 checks passed

Conversation

jmagak commented Feb 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rhdh-bot commented Feb 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

linfraze left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

linfraze left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

linfraze left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

hmanwani-rh commented Mar 21, 2025

Uh oh!

openshift-cherrypick-robot commented Mar 21, 2025

Uh oh!

hmanwani-rh commented Mar 21, 2025

Uh oh!

openshift-cherrypick-robot commented Mar 21, 2025

Uh oh!

Uh oh!

openshift-cherrypick-robot commented Mar 21, 2025

Uh oh!

openshift-cherrypick-robot commented Mar 21, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

jmagak commented Feb 19, 2025 •

edited

Loading

rhdh-bot commented Feb 19, 2025 •

edited

Loading