Skip to content

Commit 5a75420

Browse files
authored
RHIDP-6566: Rename Create with Self-service (#1077)
1 parent 58e850f commit 5a75420

File tree

11 files changed

+25
-60
lines changed

11 files changed

+25
-60
lines changed

artifacts/rhdh-plugins-reference/keycloak/keycloak-plugin-readme.adoc

Lines changed: 4 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,7 @@ The Keycloak backend plugin, which integrates Keycloak into {product-short}, has
66
* Synchronization of Keycloak users in a realm.
77
* Synchronization of Keycloak groups and their users in a realm.
88

9-
== For administrators
10-
11-
=== Installation
9+
== Installation
1210

1311
The Keycloak plugin is pre-loaded in {product-short} with basic configuration properties. To enable it, set the `disabled` property to `false` as follows:
1412

@@ -23,7 +21,7 @@ global:
2321
disabled: false
2422
----
2523

26-
=== Basic configuration
24+
== Basic configuration
2725
To enable the Keycloak plugin, you must set the following environment variables:
2826

2927
* `KEYCLOAK_BASE_URL`
@@ -36,7 +34,7 @@ To enable the Keycloak plugin, you must set the following environment variables:
3634

3735
* `KEYCLOAK_CLIENT_SECRET`
3836

39-
=== Advanced configuration
37+
== Advanced configuration
4038

4139
.Schedule configuration
4240
You can configure a schedule in the `app-config.yaml` file, as follows:
@@ -140,7 +138,7 @@ When using client credentials, the access type must be set to `confidential` and
140138
* `query-users`
141139
* `view-users`
142140

143-
=== Limitations
141+
== Limitations
144142

145143
If you have self-signed or corporate certificate issues, you can set the following environment variable before starting {product-short}:
146144

@@ -152,29 +150,3 @@ If you have self-signed or corporate certificate issues, you can set the followi
152150
The solution of setting the environment variable is not recommended.
153151
====
154152

155-
== For users
156-
157-
=== Import of users and groups in {product-short} using the Keycloak plugin
158-
159-
After configuring the plugin successfully, the plugin imports the users and groups each time when started.
160-
161-
[NOTE]
162-
====
163-
If you set up a schedule, users and groups will also be imported.
164-
====
165-
166-
After the first import is complete, you can select *User* to list the users from the catalog page:
167-
168-
image::rhdh-plugins-reference/users.jpg[catalog-list]
169-
170-
You can see the list of users on the page:
171-
172-
image::rhdh-plugins-reference/user-list.jpg[user-list]
173-
174-
When you select a user, you can see the information imported from Keycloak:
175-
176-
image::rhdh-plugins-reference/user2.jpg[user-profile]
177-
178-
You can also select a group, view the list, and select or view the information imported from Keycloak for a group:
179-
180-
image::rhdh-plugins-reference/group1.jpg[group-profile]

artifacts/rhdh-plugins-reference/keycloak/keycloak-plugin-user.adoc

Lines changed: 8 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -15,18 +15,11 @@ After configuring the plugin successfully, the plugin imports the users and grou
1515
If you set up a schedule, users and groups will also be imported.
1616
====
1717

18-
After the first import is complete, you can select *User* to list the users from the catalog page:
19-
20-
image::rhdh-plugins-reference/users.jpg[catalog-list]
21-
22-
You can see the list of users on the page:
23-
24-
image::rhdh-plugins-reference/user-list.jpg[user-list]
25-
26-
When you select a user, you can see the information imported from Keycloak:
27-
28-
image::rhdh-plugins-reference/user2.jpg[user-profile]
29-
30-
You can also select a group, view the list, and select or view the information imported from Keycloak for a group:
31-
32-
image::rhdh-plugins-reference/group1.jpg[group-profile]
18+
.Procedure
19+
. in {product}, go to the *Catalog* page.
20+
. Select *User* from the entity type filter to display the list of imported users.
21+
. Browse the list of users displayed on the page.
22+
. Select a user to view detailed information imported from Keycloak.
23+
. To view groups, select *Group* from the entity type filter.
24+
. Browse the list of groups shown on the page.
25+
. From the list of groups, select a group to view the information imported from Keycloak.

assemblies/assembly-configuring-the-global-header.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
As an administrator, you can configure the {product} global header to create a consistent and flexible navigation bar across your {product-short} instance.
77
By default, the {product-short} global header includes the following components:
88

9-
* *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}
9+
* *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}
1010
* *Support* button that can link an internal or external support page
1111
* *Notifications* button displays alerts and updates from plugins and external services
1212
* *Search* input field allows users to find services, components, documentation, and other resources within {product-short}
-88.2 KB
Binary file not shown.
-82.2 KB
Binary file not shown.
-67.7 KB
Binary file not shown.
-114 KB
Binary file not shown.

modules/configuring-the-global-header/proc-customize-rhdh-global-header.adoc

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
= Customizing your {product} global header
33

44
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.
5-
For more information on enabling dynamic plugins, see link:{installing-and-viewing-dynamic-plugins-url}[{installing-and-viewing-dynamic-plugins-title}].
5+
For more information about enabling dynamic plugins, see link:{installing-and-viewing-plugins-book-url}[{installing-and-viewing-plugins-book-title}].
66

77
.Default global header configuration
88

@@ -42,7 +42,7 @@ For more information on enabling dynamic plugins, see link:{installing-and-viewi
4242
config:
4343
priority: 90
4444
props:
45-
title: Create...
45+
title: Self-service
4646
icon: add
4747
to: create
4848
- mountPoint: global.header/component
@@ -76,7 +76,7 @@ For more information on enabling dynamic plugins, see link:{installing-and-viewi
7676
----
7777
<1> *search*: Hides the *Search* modal in the sidebar menu. Change it to `true` to display the *Search* modal in the sidebar.
7878
<2> *settings*: Hides the *Settings* button in the sidebar menu. Change it to `true` to display the *Settings* button in the sidebar.
79-
<3> `default.main-menu-items`: Hides the *Create* button from the sidebar menu. Remove this field to display the *Create* button in the sidebar.
79+
<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.
8080
<4> *position*: Defines the position of the header. Options: `above-main-content` or `above-sidebar`.
8181

8282
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
9191

9292
- **`SearchComponent`**: Adds a search bar (enabled by default).
9393
- **`Spacer`**: Adds spacing in the header to position buttons at the end. Useful when you disable `SearchComponent`.
94-
- **`HeaderIconButton`**: Adds an icon button. By default, the *Create* icon button remains enabled.
94+
- **`HeaderIconButton`**: Adds an icon button. By default, the *Self-service* icon button remains enabled.
9595
- **`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.
9696
- **`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).
9797
- **`Divider`**: Adds a vertical divider. By default, a divider appears between the profile dropdown and other header components.
9898
- **`ProfileDropdown`**: Adds a profile dropdown showing the logged-in user's name. By default, it contains two menu items.
9999
- **`MenuItemLink`**: Adds a link item in a dropdown menu. By default, the profile dropdown includes a link to the *Settings* page.
100100
- **`LogoutButton`**: Adds a logout button in the profile dropdown (enabled by default).
101-
- **`CreateDropdown`**: Adds a *Create* dropdown button (disabled by default). The menu items are configurable.
102-
- **`SoftwareTemplatesSection`**: Adds a list of software template links to the *Create* dropdown menu (disabled by default). You must enable `CreateDropdown`.
103-
- **`RegisterAComponentSection`**: Adds a link to the *Register a Component* page in the *Create* dropdown menu (disabled by default). You must enable `CreateDropdown`.
101+
- **`CreateDropdown`**: Adds a *Self-service* dropdown button (disabled by default). The menu items are configurable.
102+
- **`SoftwareTemplatesSection`**: Adds a list of software template links to the *Self-service* dropdown menu (disabled by default). You must enable `CreateDropdown`.
103+
- **`RegisterAComponentSection`**: Adds a link to the *Register a Component* page in the *Self-service* dropdown menu (disabled by default). You must enable `CreateDropdown`.
104104

105105
`config.position`::
106106
Specifies the position of the header. Supported values are `above-main-content` and `above-sidebar`.

modules/customizing-templates/proc-creating-templates.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,10 @@ You can create a template by using the Template Editor.
1414
+
1515
image::rhdh/template-editor.png[Template Editor]
1616
** Open the URL `\https://<rhdh_url>/create/edit` for your {product} instance.
17-
** Click *Create...* in the navigation menu of the {product} console, then click the overflow menu button and select *Template editor*.
17+
** Click *Self-service* in the navigation menu of the {product} console, then click the overflow menu button and select *Template editor*.
1818
. Click *Edit Template Form*.
1919
. Optional: Modify the YAML definition for the parameters of your template. For more information about these parameters, see <<Creating a template as a YAML file>>.
20-
. In the *Name ** field, enter a unique name for your template.
20+
. In the *Name* field, enter a unique name for your template.
2121
. From the *Owner* drop-down menu, choose an owner for the template.
2222
. Click *Next*.
2323
. In the *Repository Location* view, enter the following information about the hosted repository that you want to publish the template to:

modules/customizing-templates/ref-creating-templates.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,8 +57,8 @@ spec:
5757
# ...
5858
----
5959
<1> Specify a name for the template.
60-
<2> Specify a title for the template. This is the title that is visible on the template tile in the *Create...* view.
61-
<3> Specify a description for the template. This is the description that is visible on the template tile in the *Create...* view.
60+
<2> Specify a title for the template. This is the title that is visible on the template tile in the *Self-service* view.
61+
<3> Specify a description for the template. This is the description that is visible on the template tile in the *Self-service* view.
6262
<4> Specify the ownership of the template. The `owner` field provides information about who is responsible for maintaining or overseeing the template within the system or organization. In the provided example, the `owner` field is set to `backstage/techdocs-core`. This means that this template belongs to the `techdocs-core` project in the `backstage` namespace.
6363
<5> Specify the component type. Any string value is accepted for this required field, but your organization should establish a proper taxonomy for these. {product} instances may read this field and behave differently depending on its value. For example, a `website` type component may present tooling in the {product} interface that is specific to just websites.
6464
+

modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ dynamicPlugins:
3939
to: learning-paths
4040
priority: 60
4141
default.create:
42-
title: Create
42+
title: Self-service
4343
icon: add
4444
to: create
4545
priority: 50

0 commit comments

Comments
 (0)