You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: modules/getting-started/proc-customize-rhdh-homepage.adoc
+49-22Lines changed: 49 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,16 +1,8 @@
1
1
[id='proc-customize-rhdh-homepage_{context}']
2
2
= Customizing the Home page in {product}
3
3
4
-
To access the Home page in {product}, the base URL must include the `/developer-hub` proxy. You can configure the Home page by passing the data into the `app-config.yaml` file as a proxy. You can provide data to the Home page from the following sources:
5
-
6
-
* JSON files hosted on GitHub or GitLab.
7
-
* A dedicated service that provides the Home page data in JSON format using an API.
8
-
9
-
== Using hosted JSON files to provide data to the Home page
10
-
11
4
When using the `app-config`, you can do the following:
12
5
13
-
14
6
* Customize and extend the default Home page layout with additional cards that appear based on the plugins you have installed and enabled.
15
7
* Change quick access links.
16
8
* Add, reorganize, and remove the following available cards:
@@ -23,20 +15,8 @@ When using the `app-config`, you can do the following:
23
15
** Catalog starred entities
24
16
** Featured docs
25
17
18
+
The default Home page is as shown in the following `app-config` file configuration:
26
19
27
-
.Prerequisites
28
-
29
-
You have installed {product} by using either the Operator or Helm chart.
30
-
//For more information, see xref:proc-install-rhdh_rhdh-getting-started[].
31
-
//replace with link to installation guide.
32
-
33
-
34
-
.Procedure
35
-
36
-
To access the data from the JSON files, complete the following step:
37
-
38
-
* Add the following code to the `app-config.yaml` file:
39
-
+
40
20
[source,yaml]
41
21
----
42
22
dynamicPlugins:
@@ -78,6 +58,11 @@ dynamicPlugins:
78
58
xxs: { w: 12, h: 4 }
79
59
----
80
60
61
+
62
+
== Customizing the Home page cards
63
+
64
+
Administrators can change the fixed height of cards that are in a 12-column grid.
65
+
81
66
=== Example card configurations for your Home page in {product}
82
67
83
68
You can configure different cards for your Home page in {product}, as follows:
@@ -394,7 +379,49 @@ dynamicPlugins:
394
379
debugContent: right
395
380
----
396
381
397
-
== Using a dedicated service to provide data to the Home page
382
+
383
+
== Customizing the Quick access card in {product}
384
+
385
+
To access the Home page in {product}, the base URL must include the `/developer-hub` proxy. You can configure the Home page by passing the data into the `app-config.yaml` file as a proxy. You can provide data to the Home page from the following sources:
386
+
387
+
* JSON files hosted on GitHub or GitLab.
388
+
* A dedicated service that provides the Home page data in JSON format using an API.
389
+
390
+
391
+
=== Using hosted JSON files to provide data to the Quick access card
392
+
393
+
.Prerequisites
394
+
395
+
You have installed {product} by using either the Operator or Helm chart.
396
+
//For more information, see xref:proc-install-rhdh_rhdh-getting-started[].
397
+
//replace with link to installation guide.
398
+
399
+
400
+
.Procedure
401
+
402
+
To access the data from the JSON files, complete the following step:
403
+
404
+
* Add the following code to the `app-config.yaml` file:
'^/api/proxy/developer-hub': <path to json file> # i.e /janus-idp/backstage-showcase/main/packages/app/public/homepage/data.json
416
+
changeOrigin: true
417
+
secure: true
418
+
# Change to "false" in case of using self hosted cluster with a self-signed certificate
419
+
headers:
420
+
<HEADER_KEY>: <HEADER_VALUE> # optional and can be passed as needed i.e Authorization can be passed for private GitHub repo and PRIVATE-TOKEN can be passed for private GitLab repo
421
+
----
422
+
423
+
424
+
=== Using a dedicated service to provide data to the Home page
398
425
399
426
When using a dedicated service, you can do the following:
0 commit comments