Skip to content
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.

Sign up for GitHub

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

Jump to bottom

RHIDP-5604 Configuring entity tab titles and entity detail tab layout #903

Open
wants to merge 13 commits into
base: main
Choose a base branch
from
Open

RHIDP-5604 Configuring entity tab titles and entity detail tab layout #903

wants to merge 13 commits into from
+148 −0

Conversation

themr0c
Copy link
Member

@themr0c themr0c commented Jan 31, 2025 •
edited
Loading

@rhdh-bot
Copy link
Collaborator

rhdh-bot commented Jan 31, 2025 •
edited
Loading

Updated preview: https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/pr-903/ @ 03/12/25 14:01:56

@themr0c
modularization step 1
371acb4 
Signed-off-by: Fabrice Flore-Thébault <[email protected]>
@themr0c
modularization continued
7db0659 
Signed-off-by: Fabrice Flore-Thébault <[email protected]>
@themr0c
added to the outline
80228c2 
Signed-off-by: Fabrice Flore-Thébault <[email protected]>
@themr0c themr0c marked this pull request as ready for review March 11, 2025 09:37
@themr0c themr0c changed the title RHIDP-5604 Configuring Entity Page widgets and tabs layout RHIDP-5604 Configuring entity tab titles and entity detail tab layout Mar 11, 2025
debsmita1
debsmita1 reviewed Mar 12, 2025
View reviewed changes
modules/customizing-the-appearance/proc-customizing-entity-tab-titles.adoc
appConfig:
dynamicPlugins:
frontend:
backstage-community.plugin-topology:
Copy link
Member

Choose a reason for hiding this comment

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

You could mention how you did in the other files

Suggested change
backstage-community.plugin-topology:
_<your_plugin_name>_: # same as `scalprum.name` key in plugin's `package.json`

Donot want the customers to get an impression that they can do this only with topology/k8s plugin

Copy link
Member Author

Choose a reason for hiding this comment

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

Could you provide an example that helps the user configure all the tabs in a default install? (No additional plugins)

Copy link
Member

Choose a reason for hiding this comment

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

I think you can use this same example that you have used above

global:
  dynamic:
    plugins:
      - package: _<your_package_location>_ # <1>
        disabled: false
        pluginConfig:
          dynamicPlugins:
            frontend:
              _<your_plugin_name>_: # <2>
                mountPoints:
                  - mountPoint: entity.page.ci/cards # <3>
                    importName: TektonCI # <4>
                    config:
                      layout: # <5>
                        gridColumn:
                          lg: span 6
                          xs: span 12
                      if:
                        allOf:
                          - isTektonCIAvailable

global:
 dynamic:
   plugins:
     - package: _<your_package_location>_ # <1>
       disabled: false
       pluginConfig:
         dynamicPlugins:
           frontend:
             _<your_plugin_name>_: # <2>
                 entityTabs:
                    - mountPoint: entity.page.topology
                       path: /topology
                       title: Changed Topology
                    - mountPoint: entity.page.lighthouse
                       path: /lighthouse
                       title: Changed Lighthouse
                    - mountPoint: entity.page.api
                       path: /api
                       title: Changed Api
                    - mountPoint: entity.page.dependencies
                       path: /dependencies
                       title: Changed Dependencies
                    - mountPoint: entity.page.docs
                       path: /docs
                       title: Changed Docs
                    - mountPoint: entity.page.overview
                       path: /
                       title: Changed Overview

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes, but what are the expected values for <your_package_location> and <your_plugin_name>?

  • The user can decide any random value?
  • The user must use the correct package location and plugin name? Clarify either how to find the information, if the values might change, or the expected value, if the values are consistent and reproducible.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@debsmita1 debsmita1 debsmita1 left review comments

@hmanwani-rh hmanwani-rh Awaiting requested review from hmanwani-rh

@linfraze linfraze Awaiting requested review from linfraze

@christoph-jerolimov christoph-jerolimov Awaiting requested review from christoph-jerolimov

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@themr0c @rhdh-bot @debsmita1