RHIDP-4506: Docs sample for 'default.main-menu-items' is missing 'menuItems' field #741

pabel-rh · 2024-11-27T10:59:25Z

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

Version(s): 1.3.x, 1.4.x, and main
Add the relevant labels to the Pull Request.
Issue: RHIDP-4506

rhdh-bot · 2024-11-27T11:01:53Z

Updated preview: https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/pr-741/ @ 12/03/24 09:29:03

modules/customization/proc-customize-rhdh-sidebar-menuitems.adoc

themr0c · 2024-11-29T11:58:50Z

Please ask for thorough SME and QE reviews.

zdrapela

It is looking good to me. ~~It corresponds with the config we use for tests~~: https://github.com/janus-idp/backstage-showcase/blob/main/.ibm/pipelines/resources/config_map/app-config-rhdh.yaml#L20

EDIT: I was wrong and @ciiay is right. I misunderstood the dots in YAML keys.

ciiay

Hi, @pabel-rh @themr0c , default.main-menu-items, default.<menu_item_name> and default.<menu_group_parent_item_name> are key words in the code, if we break the key, it won't be recognized and the configuration will be ignored.
For example, the following configuration doesn't work.

dynamicPlugins:
  rootDirectory: dynamic-plugins-root
  frontend:    
    default:
      main-menu-items:
        menuItems:
          default:
            home:
              priority: 10

It has to be like:

dynamicPlugins:
  rootDirectory: dynamic-plugins-root
  frontend:  
    default.main-menu-items:
      menuItems:
        default.home:
          priority: 10

default.main-menu-items is just like backstage-community.plugin-acr or backstage.plugin-techdocs.

ciiay

/lgtm

Thank you 🤝

themr0c · 2024-12-05T13:52:01Z

/cherry-pick release-1.3

themr0c · 2024-12-05T13:52:14Z

/chreey-pick release-1.4

openshift-cherrypick-robot · 2024-12-05T13:52:39Z

@themr0c: new pull request created: #771

In response to this:

/cherry-pick release-1.3

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 · 2024-12-05T13:54:51Z

/cherry-pick release-1.4

openshift-cherrypick-robot · 2024-12-05T13:55:28Z

@themr0c: new pull request created: #772

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 · 2024-12-05T14:04:42Z

@ciiay This behavior might confuse users, as the dotted notation (this.that) is used all over the place in the doc set to describe:

this:
  that:

We might have to reconsider the usage of the dotted notation.

…nctions to proxy backend (#766) * RHIDP-4802 - Dynamic plugin: Document how users can add middleware functions to proxy backend * RHIDP-4566: document how to manage PVCs in RHDH operator (#702) * RHIDP-4566: document how to manage PVCs in RHDH operator * Incorporated review suggestions * Incorporate QE suggestion * chore: dynamic plugins are all now expressed as wrappers (RHIDP-5103) (#753) * chore: dynamic plugins are all now expressed as wrappers so we don't need to parse janus-plugins repo anymore Signed-off-by: Nick Boldt <[email protected]> * comment out the TP stuff and mark it with RHIDP-5103 so we can re-enable it if needed in future Signed-off-by: Nick Boldt <[email protected]> * regen content from showcase main branch Signed-off-by: Nick Boldt <[email protected]> * re-add missing community plugins Signed-off-by: Nick Boldt <[email protected]> * re-add missing community plugins (regen content) Signed-off-by: Nick Boldt <[email protected]> --------- Signed-off-by: Nick Boldt <[email protected]> Co-authored-by: Fabrice Flore-Thébault <[email protected]> * RHIDP-4409: update metric monitoring instructions for OCP and AKS (#757) * update metric monitoring instructions for OCP and AKS Signed-off-by: Jessica He <[email protected]> * modularized the content --------- Signed-off-by: Jessica He <[email protected]> Co-authored-by: Fabrice Flore-Thébault <[email protected]> Co-authored-by: Heena Manwani <[email protected]> * added missing article (#741) * chore: fix known issues search string (#774) Signed-off-by: Fabrice Flore-Thébault <[email protected]> * RHIDP-4805: RHBK v24 support for RHDH 1.4 (#767) * RHBK v24 support for RHDH 1.4 * Added note * review suggestions incorporated * RHIDP-4572: Updating /metrics port (#735) Co-authored-by: Fabrice Flore-Thébault <[email protected]> * chore(installation): remove non-OLM installation doc; add link to OLM quickstart (RHIDP-2707) (RHIDP-3497) (#700) * chore(installation): remove doc about non-OLM instlalation method; add extra link to OLM quickstart at https://olm.operatorframework.io/docs/getting-started/ (RHIDP-2707) (RHIDP-3497) Signed-off-by: Nick Boldt <[email protected]> * Update modules/installation/proc-rhdh-deploy-eks-operator.adoc Co-authored-by: Heena Manwani <[email protected]> --------- Signed-off-by: Nick Boldt <[email protected]> Co-authored-by: Heena Manwani <[email protected]> Co-authored-by: Fabrice Flore-Thébault <[email protected]> * Add supported keycloak version * Remove Audit log file rotation in RHDH * RHIDP-4802 - Dynamic plugin: Document how users can add middleware functions to proxy backend * RHIDP-4802 - Dynamic plugin: Document how users can add middleware functions to proxy backend --------- Signed-off-by: Nick Boldt <[email protected]> Signed-off-by: Jessica He <[email protected]> Signed-off-by: Fabrice Flore-Thébault <[email protected]> Co-authored-by: Heena Manwani <[email protected]> Co-authored-by: Nick Boldt <[email protected]> Co-authored-by: Fabrice Flore-Thébault <[email protected]> Co-authored-by: Jessica He <[email protected]> Co-authored-by: Heena Manwani <[email protected]> Co-authored-by: Priyanka Abel <[email protected]> Co-authored-by: jmagak <[email protected]>

…nctions to proxy backend (redhat-developer#766) * RHIDP-4802 - Dynamic plugin: Document how users can add middleware functions to proxy backend * RHIDP-4566: document how to manage PVCs in RHDH operator (redhat-developer#702) * RHIDP-4566: document how to manage PVCs in RHDH operator * Incorporated review suggestions * Incorporate QE suggestion * chore: dynamic plugins are all now expressed as wrappers (RHIDP-5103) (redhat-developer#753) * chore: dynamic plugins are all now expressed as wrappers so we don't need to parse janus-plugins repo anymore Signed-off-by: Nick Boldt <[email protected]> * comment out the TP stuff and mark it with RHIDP-5103 so we can re-enable it if needed in future Signed-off-by: Nick Boldt <[email protected]> * regen content from showcase main branch Signed-off-by: Nick Boldt <[email protected]> * re-add missing community plugins Signed-off-by: Nick Boldt <[email protected]> * re-add missing community plugins (regen content) Signed-off-by: Nick Boldt <[email protected]> --------- Signed-off-by: Nick Boldt <[email protected]> Co-authored-by: Fabrice Flore-Thébault <[email protected]> * RHIDP-4409: update metric monitoring instructions for OCP and AKS (redhat-developer#757) * update metric monitoring instructions for OCP and AKS Signed-off-by: Jessica He <[email protected]> * modularized the content --------- Signed-off-by: Jessica He <[email protected]> Co-authored-by: Fabrice Flore-Thébault <[email protected]> Co-authored-by: Heena Manwani <[email protected]> * added missing article (redhat-developer#741) * chore: fix known issues search string (redhat-developer#774) Signed-off-by: Fabrice Flore-Thébault <[email protected]> * RHIDP-4805: RHBK v24 support for RHDH 1.4 (redhat-developer#767) * RHBK v24 support for RHDH 1.4 * Added note * review suggestions incorporated * RHIDP-4572: Updating /metrics port (redhat-developer#735) Co-authored-by: Fabrice Flore-Thébault <[email protected]> * chore(installation): remove non-OLM installation doc; add link to OLM quickstart (RHIDP-2707) (RHIDP-3497) (redhat-developer#700) * chore(installation): remove doc about non-OLM instlalation method; add extra link to OLM quickstart at https://olm.operatorframework.io/docs/getting-started/ (RHIDP-2707) (RHIDP-3497) Signed-off-by: Nick Boldt <[email protected]> * Update modules/installation/proc-rhdh-deploy-eks-operator.adoc Co-authored-by: Heena Manwani <[email protected]> --------- Signed-off-by: Nick Boldt <[email protected]> Co-authored-by: Heena Manwani <[email protected]> Co-authored-by: Fabrice Flore-Thébault <[email protected]> * Add supported keycloak version * Remove Audit log file rotation in RHDH * RHIDP-4802 - Dynamic plugin: Document how users can add middleware functions to proxy backend * RHIDP-4802 - Dynamic plugin: Document how users can add middleware functions to proxy backend --------- Signed-off-by: Nick Boldt <[email protected]> Signed-off-by: Jessica He <[email protected]> Signed-off-by: Fabrice Flore-Thébault <[email protected]> Co-authored-by: Heena Manwani <[email protected]> Co-authored-by: Nick Boldt <[email protected]> Co-authored-by: Fabrice Flore-Thébault <[email protected]> Co-authored-by: Jessica He <[email protected]> Co-authored-by: Heena Manwani <[email protected]> Co-authored-by: Priyanka Abel <[email protected]> Co-authored-by: jmagak <[email protected]>

pabel-rh temporarily deployed to external November 27, 2024 10:59 — with GitHub Actions Inactive

pabel-rh added the Peer review needed 📖 label Nov 27, 2024

pabel-rh force-pushed the rhidp-4506 branch from 4e24147 to 7c4063b Compare November 28, 2024 05:26

pabel-rh temporarily deployed to external November 28, 2024 05:26 — with GitHub Actions Inactive

themr0c added QE review needed 🔧 Technical review needed 🔩 Test all the procedures labels Nov 28, 2024

themr0c reviewed Nov 28, 2024

View reviewed changes

modules/customization/proc-customize-rhdh-sidebar-menuitems.adoc Show resolved Hide resolved

themr0c reviewed Nov 28, 2024

View reviewed changes

modules/customization/proc-customize-rhdh-sidebar-menuitems.adoc Show resolved Hide resolved

themr0c reviewed Nov 28, 2024

View reviewed changes

modules/customization/proc-customize-rhdh-sidebar-menuitems.adoc Outdated Show resolved Hide resolved

pabel-rh force-pushed the rhidp-4506 branch from 7c4063b to 5aebb8e Compare November 29, 2024 08:18

pabel-rh temporarily deployed to external November 29, 2024 08:18 — with GitHub Actions Inactive

pabel-rh temporarily deployed to external November 29, 2024 08:20 — with GitHub Actions Inactive

themr0c approved these changes Nov 29, 2024

View reviewed changes

pabel-rh force-pushed the rhidp-4506 branch from c773e4f to b40c9bf Compare November 29, 2024 11:59

pabel-rh temporarily deployed to external November 29, 2024 11:59 — with GitHub Actions Inactive

zdrapela approved these changes Dec 2, 2024

View reviewed changes

zdrapela added QE review done ☀️ and removed QE review needed 🔧 labels Dec 2, 2024

ciiay suggested changes Dec 2, 2024

View reviewed changes

pabel-rh temporarily deployed to external December 3, 2024 09:24 — with GitHub Actions Inactive

pabel-rh force-pushed the rhidp-4506 branch from 0766407 to 694a602 Compare December 3, 2024 09:25

pabel-rh temporarily deployed to external December 3, 2024 09:25 — with GitHub Actions Inactive

added missing article

9ed1fcf

pabel-rh force-pushed the rhidp-4506 branch from 694a602 to 9ed1fcf Compare December 3, 2024 09:26

pabel-rh temporarily deployed to external December 3, 2024 09:26 — with GitHub Actions Inactive

ciiay approved these changes Dec 3, 2024

View reviewed changes

openshift-ci bot assigned ciiay Dec 3, 2024

openshift-ci bot added the lgtm label Dec 3, 2024

pabel-rh added Technical review done ⛅ Any procedure has been succesfully tested Ready to merge 💂 and removed Technical review needed 🔩 Test all the procedures labels Dec 3, 2024

themr0c merged commit 766c6e6 into redhat-developer:main Dec 5, 2024
3 checks passed

openshift-cherrypick-robot mentioned this pull request Dec 5, 2024

[release-1.3] RHIDP-4506: Docs sample for 'default.main-menu-items' is missing 'menuItems' field #771

Merged

openshift-cherrypick-robot mentioned this pull request Dec 5, 2024

[release-1.4] RHIDP-4506: Docs sample for 'default.main-menu-items' is missing 'menuItems' field #772

Merged

Gerry-Forde pushed a commit to Gerry-Forde/red-hat-developers-documentation-rhdh-v2 that referenced this pull request Dec 12, 2024

added missing article (redhat-developer#741)

79ca3c4

RHIDP-4506: Docs sample for 'default.main-menu-items' is missing 'menuItems' field #741

RHIDP-4506: Docs sample for 'default.main-menu-items' is missing 'menuItems' field #741

Uh oh!

Conversation

pabel-rh commented Nov 27, 2024

Uh oh!

rhdh-bot commented Nov 27, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

themr0c commented Nov 29, 2024

Uh oh!

zdrapela left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ciiay left a comment

Choose a reason for hiding this comment

Uh oh!

ciiay left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

themr0c commented Dec 5, 2024

Uh oh!

themr0c commented Dec 5, 2024

Uh oh!

openshift-cherrypick-robot commented Dec 5, 2024

Uh oh!

themr0c commented Dec 5, 2024

Uh oh!

openshift-cherrypick-robot commented Dec 5, 2024

Uh oh!

themr0c commented Dec 5, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

rhdh-bot commented Nov 27, 2024 •

edited

Loading

zdrapela left a comment •

edited

Loading