-
Notifications
You must be signed in to change notification settings - Fork 44
RHIDP-6566: Rename Create with Self-service #1077
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
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change | ||||||
---|---|---|---|---|---|---|---|---|
|
@@ -15,18 +15,11 @@ After configuring the plugin successfully, the plugin imports the users and grou | |||||||
If you set up a schedule, users and groups will also be imported. | ||||||||
==== | ||||||||
|
||||||||
After the first import is complete, you can select *User* to list the users from the catalog page: | ||||||||
|
||||||||
image::rhdh-plugins-reference/users.jpg[catalog-list] | ||||||||
|
||||||||
You can see the list of users on the page: | ||||||||
|
||||||||
image::rhdh-plugins-reference/user-list.jpg[user-list] | ||||||||
|
||||||||
When you select a user, you can see the information imported from Keycloak: | ||||||||
|
||||||||
image::rhdh-plugins-reference/user2.jpg[user-profile] | ||||||||
|
||||||||
You can also select a group, view the list, and select or view the information imported from Keycloak for a group: | ||||||||
|
||||||||
image::rhdh-plugins-reference/group1.jpg[group-profile] | ||||||||
.Procedure | ||||||||
. Go to the *Catalog* page. | ||||||||
. Select *User* from the entity type filter to display the list of imported users. | ||||||||
. Browse the list of users displayed on the page. | ||||||||
. Select a user to view detailed information imported from Keycloak. | ||||||||
. To view groups, select *Group* from the entity type filter. | ||||||||
. Browse the list of groups shown on the page. | ||||||||
. Select a group to view the information imported from Keycloak. | ||||||||
Comment on lines
+24
to
+25
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. You can combine these into a single step or maybe replace with something like the following:
Suggested change
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -6,7 +6,7 @@ | |
As an administrator, you can configure the {product} global header to create a consistent and flexible navigation bar across your {product-short} instance. | ||
By default, the {product-short} global header includes the following components: | ||
|
||
* *Create* button provides quick access to a variety of templates, enabling users to efficiently set up services, backend and front-end plugins within {product-short} | ||
* *Self-service* button provides quick access to a variety of templates, enabling users to efficiently set up services, backend and front-end plugins within {product-short} | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The change to Self-service looks good but wondering if we should use back end or back-end. IBM says to only use backend when referring to a specific product or thing in Python. |
||
* *Support* button that can link an internal or external support page | ||
* *Notifications* button displays alerts and updates from plugins and external services | ||
* *Search* input field allows users to find services, components, documentation, and other resources within {product-short} | ||
|
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -2,7 +2,7 @@ | |||||
= Customizing your {product} global header | ||||||
|
||||||
You can use the `red-hat-developer-hub.backstage-plugin-global-header` dynamic plugin to extend the global header with additional buttons and customize the order and position of icons and features. Additionally, you can create and integrate your custom dynamic header plugins using the mount points provided by this new header feature, allowing you to further tailor to suit your needs. | ||||||
For more information on enabling dynamic plugins, see link:{installing-and-viewing-dynamic-plugins-url}[{installing-and-viewing-dynamic-plugins-title}]. | ||||||
For more information on enabling dynamic plugins, see link:{installing-and-viewing-plugins-book-url}[{installing-and-viewing-plugins-book-title}]. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
I recall one of the style guides saying to use about in place of on in this context |
||||||
|
||||||
.Default global header configuration | ||||||
|
||||||
|
@@ -42,7 +42,7 @@ For more information on enabling dynamic plugins, see link:{installing-and-viewi | |||||
config: | ||||||
priority: 90 | ||||||
props: | ||||||
title: Create... | ||||||
title: Self-service | ||||||
icon: add | ||||||
to: create | ||||||
- mountPoint: global.header/component | ||||||
|
@@ -76,7 +76,7 @@ For more information on enabling dynamic plugins, see link:{installing-and-viewi | |||||
---- | ||||||
<1> *search*: Hides the *Search* modal in the sidebar menu. Change it to `true` to display the *Search* modal in the sidebar. | ||||||
<2> *settings*: Hides the *Settings* button in the sidebar menu. Change it to `true` to display the *Settings* button in the sidebar. | ||||||
<3> `default.main-menu-items`: Hides the *Create* button from the sidebar menu. Remove this field to display the *Create* button in the sidebar. | ||||||
<3> `default.main-menu-items`: Hides the *Self-service* button from the sidebar menu. Remove this field to display the *Self-service* button in the sidebar. | ||||||
<4> *position*: Defines the position of the header. Options: `above-main-content` or `above-sidebar`. | ||||||
|
||||||
To extend the functionality of the default global header, include any the following attributes in your global header entry: | ||||||
|
@@ -91,16 +91,16 @@ The `red-hat-developer-hub.backstage-plugin-global-header` package (enabled by d | |||||
|
||||||
- **`SearchComponent`**: Adds a search bar (enabled by default). | ||||||
- **`Spacer`**: Adds spacing in the header to position buttons at the end. Useful when you disable `SearchComponent`. | ||||||
- **`HeaderIconButton`**: Adds an icon button. By default, the *Create* icon button remains enabled. | ||||||
- **`HeaderIconButton`**: Adds an icon button. By default, the *Self-service* icon button remains enabled. | ||||||
- **`SupportButton`**: Adds a *Support* icon button, allowing users to configure a link to an internal or external page. Enabled by default but requires additional configuration to display. | ||||||
- **`NotificationButton`**: Adds a *Notifications* icon button to display unread notifications in real time and navigate to the *Notifications* page. Enabled by default (requires the notifications plugin). | ||||||
- **`Divider`**: Adds a vertical divider. By default, a divider appears between the profile dropdown and other header components. | ||||||
- **`ProfileDropdown`**: Adds a profile dropdown showing the logged-in user's name. By default, it contains two menu items. | ||||||
- **`MenuItemLink`**: Adds a link item in a dropdown menu. By default, the profile dropdown includes a link to the *Settings* page. | ||||||
- **`LogoutButton`**: Adds a logout button in the profile dropdown (enabled by default). | ||||||
- **`CreateDropdown`**: Adds a *Create* dropdown button (disabled by default). The menu items are configurable. | ||||||
- **`SoftwareTemplatesSection`**: Adds a list of software template links to the *Create* dropdown menu (disabled by default). You must enable `CreateDropdown`. | ||||||
- **`RegisterAComponentSection`**: Adds a link to the *Register a Component* page in the *Create* dropdown menu (disabled by default). You must enable `CreateDropdown`. | ||||||
- **`CreateDropdown`**: Adds a *Self-service* dropdown button (disabled by default). The menu items are configurable. | ||||||
- **`SoftwareTemplatesSection`**: Adds a list of software template links to the *Self-service* dropdown menu (disabled by default). You must enable `CreateDropdown`. | ||||||
- **`RegisterAComponentSection`**: Adds a link to the *Register a Component* page in the *Self-service* dropdown menu (disabled by default). You must enable `CreateDropdown`. | ||||||
|
||||||
`config.position`:: | ||||||
Specifies the position of the header. Supported values are `above-main-content` and `above-sidebar`. | ||||||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It can be helpful to orient the user so they know where to start. From where do they go to the Catalog page? Do we mean something like From the {product} home page or In the {product} navigation menu, click Catalog?