generated from redhat-developer/new-project-template
-
Notifications
You must be signed in to change notification settings - Fork 58
RHIDP-5604 Configuring entity tab titles and entity detail tab layout #903
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
Merged
themr0c
merged 19 commits into
redhat-developer:main
from
themr0c:RHIDP-5604-entity-page-widgets-and-tabs
Apr 3, 2025
Merged
Changes from 17 commits
Commits
Show all changes
19 commits
Select commit
Hold shift + click to select a range
7e2342d
RHIDP-5604 Configuring Entity Page widgets and tabs layout
themr0c 2326dcd
modularization step 1
themr0c 1b172fc
modularization continued
themr0c b047f12
added to the outline
themr0c feaa4cb
Update modules/customizing-the-appearance/proc-customizing-entity-det…
themr0c fa73c60
Update modules/customizing-the-appearance/proc-customizing-entity-tab…
themr0c ec1a230
Update modules/customizing-the-appearance/proc-customizing-entity-tab…
themr0c 3c74a1a
Update modules/customizing-the-appearance/proc-customizing-entity-tab…
themr0c 7bf435f
Update modules/customizing-the-appearance/proc-customizing-entity-tab…
themr0c 6a8f5e8
Update modules/customizing-the-appearance/proc-customizing-entity-tab…
themr0c 2e5cc38
Update modules/customizing-the-appearance/proc-customizing-entity-tab…
themr0c 71ff6a7
Update modules/customizing-the-appearance/proc-customizing-entity-tab…
themr0c 13f1504
applied @debsmita1 suggestions
themr0c 4722fca
formatting
themr0c 18659cb
formatting
themr0c 7fb0212
Merge branch 'main' into RHIDP-5604-entity-page-widgets-and-tabs
themr0c e03ea58
applying style suggestions
themr0c 6b7fede
applying style suggestions
themr0c 380a927
typo
themr0c File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
50 changes: 50 additions & 0 deletions
50
modules/customizing-the-appearance/proc-customizing-entity-detail-tab-layout.adoc
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| [id="configuring-entity-detail-tab-layout_{context}"] | ||
| = Configuring entity detail tab layout | ||
|
|
||
| Each {product} entity detail tab has a default opinionated layout. | ||
| For consistency with your organization needs, you can change the entity detail tab content when the plugin that contributes the tab content allows a configuration. | ||
|
|
||
| .Prerequisites | ||
|
|
||
| * The plugin that contributes the tab content allows a configuration, such as https://github.com/redhat-developer/rhdh/blob/release-{product-version}/dynamic-plugins.default.yaml[{product-short} plugins defining a default configuration in a `config` section]. | ||
|
|
||
| .Procedure | ||
|
|
||
| * Copy the plugin default configuration in your `{my-app-config-file}` file, and change the `layout` properties. | ||
| + | ||
| [source,yaml,subs="+quotes"] | ||
| ---- | ||
| global: | ||
| dynamic: | ||
| plugins: | ||
| - package: _<package_location>_ | ||
| disabled: false | ||
| pluginConfig: | ||
| dynamicPlugins: | ||
| frontend: | ||
| _<plugin_name>_: | ||
| mountPoints: | ||
| - mountPoint: _<mount_point>_ | ||
| importName: _<import_name>_ | ||
| config: | ||
| layout: | ||
| gridColumn: | ||
| lg: span 6 | ||
| xs: span 12 | ||
| ---- | ||
| `package`:: | ||
| Enter your package location, such as `./dynamic-plugins/dist/backstage-community-plugin-tekton`. | ||
|
|
||
| `_<plugin_name>_`:: | ||
| Enter your plugin name, such as: `backstage-community.plugin-tekton`. | ||
|
|
||
| `mountPoint`:: | ||
| Copy the mount point defined in the plugin default configuration, such as: `entity.page.ci/cards`. | ||
|
|
||
| `importName`:: | ||
| Copy the import name defined in the plugin default configuration, such as: `TektonCI`. | ||
|
|
||
| `layout`:: Enter your layout configuration. | ||
| The tab content is displayed in a responsive grid that uses a 12 column-grid and supports different breakpoints (`xs`, | ||
| `sm`, `md`, `lg`, `xl`) that can be specified for a CSS property, such as `gridColumn`. | ||
| The example uses 6 of the 12 columns to show two Tekton CI cards side-by-side on large (`lg`) screens (`span 6` columns) and show them among themselves (`xs` and above `span 12` columns). |
42 changes: 42 additions & 0 deletions
42
modules/customizing-the-appearance/proc-customizing-entity-tab-titles.adoc
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| [id="configuring-entity-tab-titles_{context}"] | ||
| = Configuring entity tab titles | ||
|
|
||
| {product} provides an default opinionated tab set for catalog entity views. | ||
| For consistency with your organization needs, you can rename, reorder, remove, and add tab titles. | ||
|
|
||
| .Procedure | ||
| * For each tab to modify, enter your desired values in the `entityTabs` section in your `{my-app-config-file}` file: | ||
| + | ||
| [source,yaml,subs="+quotes"] | ||
| ---- | ||
| upstream: | ||
| backstage: | ||
| appConfig: | ||
| dynamicPlugins: | ||
| frontend: | ||
| _<your_plugin_name>_: | ||
| entityTabs: | ||
| - mountPoint: _<mount_point>_ | ||
| path: _<path>_ | ||
| title: _<title>_ | ||
| priority: _<priority>_ | ||
| ---- | ||
|
|
||
| `_<your_plugin_name>_`:: | ||
| Enter the plugin name, such as `backstage-community.plugin-topology`. | ||
themr0c marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| `mountPoint`:: | ||
| Enter the tab mountpoint, such as `entity.page.topology`. | ||
|
|
||
| `path`:: | ||
| Enter the tab path, such as `/topology`. | ||
| `title`:: | ||
| Enter the tab title, such as `Topology`. | ||
|
|
||
| `priority`:: | ||
| Optional. | ||
| + | ||
| To reorder tabs, enter the tab priority, such as `42`. | ||
| Higher priority appears first. | ||
| + | ||
| To remove a tab, enter a negative value, such as `-1`. | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.