Skip to content

Commit ce322be

Browse files
committed
Modifies the customizing Home page
1 parent c713dad commit ce322be

File tree

1 file changed

+49
-22
lines changed

1 file changed

+49
-22
lines changed

modules/getting-started/proc-customize-rhdh-homepage.adoc

Lines changed: 49 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,8 @@
11
[id='proc-customize-rhdh-homepage_{context}']
22
= Customizing the Home page in {product}
33

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-
114
When using the `app-config`, you can do the following:
125

13-
146
* Customize and extend the default Home page layout with additional cards that appear based on the plugins you have installed and enabled.
157
* Change quick access links.
168
* Add, reorganize, and remove the following available cards:
@@ -23,20 +15,8 @@ When using the `app-config`, you can do the following:
2315
** Catalog starred entities
2416
** Featured docs
2517

18+
The default Home page is as shown in the following `app-config` file configuration:
2619

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-
+
4020
[source,yaml]
4121
----
4222
dynamicPlugins:
@@ -78,6 +58,11 @@ dynamicPlugins:
7858
xxs: { w: 12, h: 4 }
7959
----
8060

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+
8166
=== Example card configurations for your Home page in {product}
8267

8368
You can configure different cards for your Home page in {product}, as follows:
@@ -394,7 +379,49 @@ dynamicPlugins:
394379
debugContent: right
395380
----
396381

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:
405+
+
406+
[source,yaml]
407+
----
408+
proxy:
409+
endpoints:
410+
# Other Proxies
411+
# customize developer hub instance
412+
'/developer-hub':
413+
target: <DOMAIN_URL> # i.e https://raw.githubusercontent.com/
414+
pathRewrite:
415+
'^/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
398425

399426
When using a dedicated service, you can do the following:
400427

0 commit comments

Comments
 (0)