Skip to content

Commit db0113c

Browse files
themr0cthemr0c
authored
Merge branch 'main' into RHIDP-7849
2 parents 295627a + c8c5cd3 commit db0113c

File tree

47 files changed

+1107
-541
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

47 files changed

+1107
-541
lines changed

‎.vscode/settings.json‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
{
22
"cSpell.words": [
3-
"preconfigured"
3+
"preconfigured",
4+
"quicklinks"
45
]
56
}

‎assemblies/assembly-adoption-insights.adoc‎

Lines changed: 30 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,30 @@
11
[id="assembly-adoption-insights"]
22
= Adoption Insights
33

4-
include::../artifacts/snip-developer-preview.adoc[]
4+
The {product} instance comes with the Adoption Insights plugin preinstalled and enabled by default.
55

6-
//about adoption insights
7-
include::modules/observe/adoption-insights/con-about-adoption-insights.adoc[leveloffset=+1]
6+
As organizations generate an increasing number of data events, there is a growing need for detailed insights into the adoption and engagement metrics of the internal developer portal. These insights help platform engineers make data-driven decisions to improve its performance, usability, and translate them into actionable insights.
87

9-
//installing adoption insights
10-
include::modules/observe/adoption-insights/proc-install-adoption-insights.adoc[leveloffset=+1]
8+
You can use Adoption Insights in {product} to visualize key metrics and trends to get information about the usage of {product-short} in your organization. The information provided by Adoption Insights in {product-short} helps you pinpoint areas of improvement, highlights popular features, and evaluates progress toward adoption goals. You can also monitor user growth against licensed users and identify trends over time.
9+
10+
The Adoption Insights dashboard in {product-short} includes the following cards:
11+
12+
* *Active users*
13+
* *Total number of users*
14+
* *Top catalog entities*
15+
* *Top 3 templates*
16+
* *Top 3 techdocs*
17+
* *Top 3 plugins*
18+
* *Portal searches*
19+
20+
image::rhdh-plugins-reference/adoption-insights.jpg[adoption insights]
1121

1222
//configuring adoption insights
1323
include::modules/observe/adoption-insights/proc-configure-adoption-insights.adoc[leveloffset=+1]
1424

25+
//disabling adoption insights
26+
include::modules/observe/adoption-insights/proc-customize-adoption-insights.adoc[leveloffset=+1]
27+
1528
//using adoption insights
1629
include::modules/observe/adoption-insights/proc-using-adoption-insights.adoc[leveloffset=+1]
1730

@@ -21,6 +34,18 @@ include::modules/observe/adoption-insights/proc-setting-duration-of-data-metrics
2134
//viewing cards
2235
include::modules/observe/adoption-insights/proc-viewing-adoption-insights-card.adoc[leveloffset=+1]
2336

37+
include::modules/observe/adoption-insights/proc-viewing-active-users.adoc[leveloffset=+2]
38+
39+
include::modules/observe/adoption-insights/proc-viewing-total-number-of-users.adoc[leveloffset=+2]
40+
41+
include::modules/observe/adoption-insights/proc-viewing-top-catalog-entities.adoc[leveloffset=+2]
42+
43+
include::modules/observe/adoption-insights/proc-viewing-top-templates.adoc[leveloffset=+2]
44+
45+
include::modules/observe/adoption-insights/proc-viewing-top-techdocs.adoc[leveloffset=+2]
46+
47+
include::modules/observe/adoption-insights/proc-viewing-top-plugins.adoc[leveloffset=+2]
48+
2449
//modify number of displayed records
2550
include::modules/observe/adoption-insights/proc-modify-number-of-displayed-records.adoc[leveloffset=+1]
2651

‎assemblies/assembly-configuring-techdocs.adoc‎

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
:_mod-docs-content-type: ASSEMBLY
22
:context: configuring-techdocs
33
[id="{context}"]
4-
= TechDocs configuration
4+
= Configuring TechDocs
55

66
The TechDocs plugin is preinstalled and enabled on a {product-short} instance by default. You can disable or enable the TechDocs plugin, and change other parameters, by configuring the {product} Helm chart or the {product} Operator ConfigMap.
77

@@ -19,22 +19,23 @@ After you configure {odf-name} to store the files that TechDocs generates, you c
1919

2020
* For more information, see link:{configuring-dynamic-plugins-book-url}[{configuring-dynamic-plugins-book-title}].
2121
22+
//configuring storage
2223
include::modules/customizing-techdocs/con-techdocs-configure-storage.adoc[leveloffset=+1]
2324

25+
//configuring storage - Amazon S3
26+
include::modules/techdocs/proc-techdocs-configure-amazon-s3-storage.adoc[leveloffset=+2]
27+
28+
//configuring storage - ODF
2429
include::modules/customizing-techdocs/proc-techdocs-using-odf-storage.adoc[leveloffset=+2]
2530

26-
include::modules/customizing-techdocs/proc-techdocs-configure-odf-helm.adoc[leveloffset=+2]
31+
include::modules/customizing-techdocs/proc-techdocs-configure-odf-helm.adoc[leveloffset=+3]
2732

28-
include::modules/customizing-techdocs/ref-techdocs-example-config-plugin-helm.adoc[leveloffset=+3]
33+
include::modules/customizing-techdocs/ref-techdocs-example-config-plugin-helm.adoc[leveloffset=+4]
2934

30-
include::modules/customizing-techdocs/proc-techdocs-configure-odf-operator.adoc[leveloffset=+2]
35+
include::modules/customizing-techdocs/proc-techdocs-configure-odf-operator.adoc[leveloffset=+3]
3136

32-
include::modules/customizing-techdocs/ref-techdocs-example-config-plugin-operator.adoc[leveloffset=+3]
37+
include::modules/customizing-techdocs/ref-techdocs-example-config-plugin-operator.adoc[leveloffset=+4]
3338

39+
//configuring CI/CD
3440
include::modules/customizing-techdocs/con-techdocs-config-cicd.adoc[leveloffset=+1]
3541

36-
include::modules/customizing-techdocs/proc-techdocs-config-cicd-prep-repo.adoc[leveloffset=+2]
37-
38-
include::modules/customizing-techdocs/proc-techdocs-generate-site.adoc[leveloffset=+2]
39-
40-
include::modules/customizing-techdocs/proc-techdocs-publish-site.adoc[leveloffset=+2]

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

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,8 @@ By default, the {product-short} global header includes the following components:
1616
include::modules/configuring-the-global-header/proc-customize-rhdh-global-header.adoc[leveloffset=+1]
1717

1818

19-
include::modules/configuring-the-global-header/proc-mount-points.adoc[leveloffset=+1]
19+
include::modules/configuring-the-global-header/proc-mount-points.adoc[leveloffset=+1]
20+
21+
include::modules/configuring-the-global-header/con-quicklinks-and-starred-items-in-global-header.adoc[leveloffset=+1]
22+
23+
include::modules/configuring-the-global-header/proc-enabling-quicklinks-starred-items-after-upgrade.adoc[leveloffset=+1]

‎assemblies/assembly-log-levels.adoc‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
[id="assembly-log-levels_{context}"]
2+
= Log Levels
3+
4+
Logging is an essential part of monitoring and debugging software applications. It provides insight into how the application is functioning at runtime and can help you detect and diagnose issues. By adjusting the log level, you can control the amount and type of information displayed in the logs, ranging from highly detailed diagnostic output to the most critical errors. With this flexibility, you can customize logging output to match your current requirements, whether during development, testing, or production.
5+
6+
You can choose from the following log levels, listed in order of decreasing verbosity:
7+
8+
- `debug`: Detailed information, typically useful only when troubleshooting.
9+
- `info`: General information about the operation of the application. This is the default level.
10+
- `warn`: Indicates potential issues or situations that might require attention.
11+
- `error`: Indicates errors that have occurred but might not prevent the application from continuing.
12+
- `critical`: Indicates critical errors that require immediate attention and are likely to prevent the application from functioning correctly.
13+
14+
You can control the verbosity of the logging by setting the log level. The log level determines the minimum severity level of events displayed in the console. For example, if the log level is set to 'info', events with a severity level of 'debug' are ignored.
15+
16+
To increase the log level, you can set the `LOG_LEVEL` environment variable to a higher severity level, such as 'warn' or 'error'. However, increasing the log level might not result in more output if the existing code primarily emits logs at lower severity levels, for example, 'debug' or 'info'. In such a case, adjust the logging statements within the code to use higher severity levels to see more output.
17+
18+
No additional steps are required beyond setting the `LOG_LEVEL` environment variable, but its effectiveness depends on the existing logging statements in the code.

‎assemblies/assembly-logging-with-amazon-cloudwatch.adoc‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,6 @@
22
= Logging with Amazon CloudWatch
33

44
Logging within the {product} relies on the link:https://github.com/winstonjs/winston[Winston library].
5-
The default logging level is `info`.
6-
To have more detailed logs, set the `LOG_LEVEL` environment variable to `debug` in your {product} instance.
7-
85

96
include::modules/observe/proc-configuring-the-application-log-level-for-logging-with-amazon-cloudwatch-logs-by-using-the-operator.adoc[leveloffset=+1]
107

‎assemblies/assembly-using-techdocs.adoc‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,3 +12,9 @@ include::modules/techdocs/proc-techdocs-find-docs.adoc[leveloffset=+1]
1212
include::modules/techdocs/proc-techdocs-view-docs.adoc[leveloffset=+1]
1313

1414
include::modules/techdocs/proc-techdocs-edit-docs.adoc[leveloffset=+1]
15+
16+
//embedding videos
17+
include::modules/techdocs/proc-techdocs-embed-videos.adoc[leveloffset=+1]
18+
19+
//generating pipelines with GitHub Actions
20+
include::modules/techdocs/proc-techdocs-pipeline-github-actions.adoc[leveloffset=+1]

‎modules/configuring-high-availability/proc-configuring-high-availability-in-rhdh-operator-deployment.adoc‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,12 @@ kind: Backstage
1616
metadata:
1717
name: _<your_yaml_file>_
1818
spec:
19-
application:
20-
...
21-
replicas: _<replicas_value>_ <1>
22-
...
19+
deployment:
20+
patch:
21+
spec:
22+
...
23+
replicas: _<replicas_value>_ <1>
24+
...
2325
----
2426
====
2527
<1> Set the number of replicas based on the number of backup instances that you want to configure.

‎modules/configuring-the-global-header/con-quicklinks-and-starred-items-in-global-header.adoc‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
[id="quicklinks-and-starred-items-in-global-header_{context}"]
2+
= Quicklinks and Starred Items in the global header
3+
4+
The *Quicklinks* matrix and *Starred Items* drop-down list are enabled by default and appear in the global header without requiring additional configuration.
5+
6+
The *Quicklinks* matrix, organized by sections (for example, Documentation or Developer Tools), allows users to quickly access internal or external resources. The *Starred Items* drop-down list contains entities and pages that the user has starred.
7+
8+
The default configuration includes the following components:
9+
10+
*StarredDropdown*: Displays the *Starred Items* menu in the global header by default, as shown in the following configuration:
11+
12+
[source,yaml]
13+
----
14+
# Group: Global Header
15+
- package: ./dynamic-plugins/dist/red-hat-developer-hub-backstage-plugin-global-header
16+
- mountPoint: global.header/component
17+
importName: StarredDropdown
18+
config:
19+
priority: 85
20+
----
21+
22+
*ApplicationLauncherDropdown*: Provides the *Quicklinks* matrix (application launcher) by default, as shown in the following configuration:
23+
24+
[source,yaml]
25+
----
26+
# Group: Global Header
27+
- package: ./dynamic-plugins/dist/red-hat-developer-hub-backstage-plugin-global-header
28+
- mountPoint: global.header/component
29+
importName: ApplicationLauncherDropdown
30+
config:
31+
priority: 82
32+
----
33+
34+
*MenuItemLink entries*: Define sections, titles, icons, and links within the *Quicklinks* matrix. The default configuration includes links to the {product-short} documentation and an {product-very-short} Local, as shown in the following configurations:
35+
36+
[source,yaml]
37+
----
38+
- mountPoint: global.header/application-launcher
39+
importName: MenuItemLink
40+
config:
41+
section: Documentation
42+
priority: 150
43+
props:
44+
title: Developer Hub
45+
icon: developerHub
46+
link: https://docs.redhat.com/en/documentation/red_hat_developer_hub
47+
48+
- mountPoint: global.header/application-launcher
49+
importName: MenuItemLink
50+
config:
51+
section: Developer Tools
52+
priority: 100
53+
props:
54+
title: RHDH Local
55+
icon: developerHub
56+
link: https://github.com/redhat-developer/rhdh-local
57+
----
58+
59+
[NOTE]
60+
====
61+
When upgrading from previous versions, the installer does not overwrite your existing `dynamic-plugins.yaml` configuration. If you had not configured *Starred Items* or *Quicklinks* previously, they remain disabled after the upgrade and must be manually enabled.
62+
====
63+
64+
65+
66+

‎modules/configuring-the-global-header/proc-enabling-quicklinks-starred-items-after-upgrade.adoc‎

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
[id="enabling-quicklinks-starred-items-upgrade_{context}"]
2+
= Enabling Quicklinks and Starred Items after an upgrade
3+
4+
If you upgrade from {product} `1.6` or earlier, {product} does not automatically enable the *Quicklinks* and *Starred Items* features. You must manually configure these features to display them in the global header.
5+
6+
.Prerequisites
7+
8+
. You have access to your {product} configuration files.
9+
. You have administrative permissions to modify ConfigMaps (if using the Operator).
10+
11+
.Procedure
12+
13+
. Locate your `dynamic-plugin` configuration.
14+
15+
* Operator deployment: The configuration is stored in a ConfigMap referenced by your Backstage custom resource (CR).
16+
* Helm deployment: The configuration is in your `values.yaml` file or separate configuration files.
17+
18+
. Enable the global header plugin. Ensure that the `red-hat-developer-hub-backstage-plugin-global-header` entry exists under the `plugins: list` and that `disabled` is set to `false`.
19+
20+
. Verify that you enabled the global header plugin.
21+
Confirm that you listed the `red-hat-developer-hub-backstage-plugin-global-header` plugin under `plugins:` with `disabled: false` (or without a `disabled` property):
22+
+
23+
[source,yaml]
24+
----
25+
- package: ./dynamic-plugins/dist/red-hat-developer-hub-backstage-plugin-global-header
26+
disabled: false
27+
----
28+
29+
. Add the required components. Under the `mountPoints` section of the plugin, add the components as shown in the following example:
30+
+
31+
[source,yaml]
32+
----
33+
mountPoints:
34+
- mountPoint: application/header
35+
importName: GlobalHeader
36+
config:
37+
position: above-sidebar
38+
- mountPoint: global.header/component
39+
importName: StarredDropdown
40+
config:
41+
priority: 85
42+
- mountPoint: global.header/component
43+
importName: ApplicationLauncherDropdown
44+
config:
45+
priority: 82
46+
- mountPoint: global.header/component
47+
importName: MenuItemLink
48+
config:
49+
section: Documentation
50+
priority: 150
51+
props:
52+
title: Developer Hub
53+
icon: developerHub
54+
link: https://docs.redhat.com/en/documentation/red_hat_developer_hub
55+
- mountPoint: global.header/application-launcher
56+
importName: MenuItemLink
57+
config:
58+
section: Developer Tools
59+
priority: 100
60+
props:
61+
title: RHDH Local
62+
icon: developerHub
63+
link: https://github.com/redhat-developer/rhdh-local
64+
----
65+
66+
. Apply the configuration.
67+
68+
* Operator deployment: Update the ConfigMap and allow the Operator to reconcile the changes.
69+
* Helm deployment: Apply your updated configuration using `helm upgrade`.
70+
71+
. Verify the features are enabled.
72+
After the {product} instance restarts, confirm that the star icon and *Quicklinks* matrix appear in the global header.

0 commit comments

Comments
 (0)