@@ -10,9 +10,19 @@ To access the Home page in {product}, the base URL must include the `/developer-
1010
1111When using the `app-config`, you can do the following:
1212
13+
1314* Customize and extend the default Home page layout with additional cards that appear based on the plugins you have installed and enabled.
14- * Add, reorganize, and remove the cards.
1515* Change quick access links.
16+ * Add, reorganize, and remove the following available cards:
17+ +
18+ * Search bar
19+ * Quick access
20+ * Headline
21+ * Markdown
22+ * Placeholder
23+ * Catalog starred entities
24+ * Featured docs
25+
1626
1727.Prerequisites
1828
@@ -68,6 +78,204 @@ dynamicPlugins:
6878 xxs: { w: 12, h: 4 }
6979----
7080
81+ === Example card configurations for your Home page in {product}
82+
83+ You can configure different cards for your Home page in {product}, as follows:
84+
85+ Search::
86+ +
87+ --
88+ [source,yaml]
89+ ----
90+ dynamicPlugins:
91+ frontend:
92+ janus-idp.backstage-plugin-dynamic-home-page:
93+ mountPoints:
94+ - mountPoint: home.page/cards
95+ importName: SearchBar
96+ config:
97+ layouts:
98+ xl: { w: 10, h: 1, x: 1 }
99+ lg: { w: 10, h: 1, x: 1 }
100+ md: { w: 10, h: 1, x: 1 }
101+ sm: { w: 10, h: 1, x: 1 }
102+ xs: { w: 12, h: 1 }
103+ xxs: { w: 12, h: 1 }
104+ ----
105+
106+ .Available props
107+
108+ |===
109+ | Prop | Default | Description
110+
111+ | `path`
112+ | `/search`
113+ | Override the linked search path if needed
114+
115+ | `queryParam`
116+ | `query`
117+ | Override the search query parameter name if needed
118+ |===
119+ --
120+
121+ Quick access::
122+ +
123+ --
124+ [source,yaml]
125+ ----
126+ dynamicPlugins:
127+ frontend:
128+ janus-idp.backstage-plugin-dynamic-home-page:
129+ mountPoints:
130+ - mountPoint: home.page/cards
131+ importName: QuickAccessCard
132+ config:
133+ layouts:
134+ xl: { h: 8 }
135+ lg: { h: 8 }
136+ md: { h: 8 }
137+ sm: { h: 8 }
138+ xs: { h: 8 }
139+ xxs: { h: 8 }
140+ ----
141+
142+ .Available props
143+
144+ |===
145+ | Prop | Default | Description
146+
147+ | `title`
148+ | `Quick Access`
149+ | Override the linked search path if needed
150+
151+ | `path`
152+ | none
153+ | Override the search query parameter name if needed
154+ |===
155+ --
156+
157+ Headline::
158+ +
159+ --
160+ [source,yaml]
161+ ----
162+ dynamicPlugins:
163+ frontend:
164+ janus-idp.backstage-plugin-dynamic-home-page:
165+ mountPoints:
166+ - mountPoint: home.page/cards
167+ importName: Headline
168+ config:
169+ layouts:
170+ xl: { h: 1 }
171+ lg: { h: 1 }
172+ md: { h: 1 }
173+ sm: { h: 1 }
174+ xs: { h: 1 }
175+ xxs: { h: 1 }
176+ props:
177+ title: Important info
178+ ----
179+
180+ .Available props
181+
182+ |===
183+ | Prop | Default | Description
184+
185+ | `title`
186+ | none
187+ | Title
188+ |===
189+ --
190+
191+ Markdown::
192+ +
193+ --
194+ [source,yaml]
195+ ----
196+ dynamicPlugins:
197+ frontend:
198+ janus-idp.backstage-plugin-dynamic-home-page:
199+ mountPoints:
200+ - mountPoint: home.page/cards
201+ importName: SearchBar
202+ config:
203+ layouts:
204+ xl: { w: 10, h: 1, x: 1 }
205+ lg: { w: 10, h: 1, x: 1 }
206+ md: { w: 10, h: 1, x: 1 }
207+ sm: { w: 10, h: 1, x: 1 }
208+ xs: { w: 12, h: 1 }
209+ xxs: { w: 12, h: 1 }
210+ ----
211+ --
212+
213+ Placeholder::
214+ +
215+ --
216+ [source,yaml]
217+ ----
218+ dynamicPlugins:
219+ frontend:
220+ janus-idp.backstage-plugin-dynamic-home-page:
221+ mountPoints:
222+ - mountPoint: home.page/cards
223+ importName: SearchBar
224+ config:
225+ layouts:
226+ xl: { w: 10, h: 1, x: 1 }
227+ lg: { w: 10, h: 1, x: 1 }
228+ md: { w: 10, h: 1, x: 1 }
229+ sm: { w: 10, h: 1, x: 1 }
230+ xs: { w: 12, h: 1 }
231+ xxs: { w: 12, h: 1 }
232+ ----
233+ --
234+
235+ Catalog starred entities::
236+ +
237+ --
238+ [source,yaml]
239+ ----
240+ dynamicPlugins:
241+ frontend:
242+ janus-idp.backstage-plugin-dynamic-home-page:
243+ mountPoints:
244+ - mountPoint: home.page/cards
245+ importName: SearchBar
246+ config:
247+ layouts:
248+ xl: { w: 10, h: 1, x: 1 }
249+ lg: { w: 10, h: 1, x: 1 }
250+ md: { w: 10, h: 1, x: 1 }
251+ sm: { w: 10, h: 1, x: 1 }
252+ xs: { w: 12, h: 1 }
253+ xxs: { w: 12, h: 1 }
254+ ----
255+ --
256+
257+ Featured docs::
258+ +
259+ --
260+ [source,yaml]
261+ ----
262+ dynamicPlugins:
263+ frontend:
264+ janus-idp.backstage-plugin-dynamic-home-page:
265+ mountPoints:
266+ - mountPoint: home.page/cards
267+ importName: SearchBar
268+ config:
269+ layouts:
270+ xl: { w: 10, h: 1, x: 1 }
271+ lg: { w: 10, h: 1, x: 1 }
272+ md: { w: 10, h: 1, x: 1 }
273+ sm: { w: 10, h: 1, x: 1 }
274+ xs: { w: 12, h: 1 }
275+ xxs: { w: 12, h: 1 }
276+ ----
277+ --
278+
71279=== Defining the layout of the {product} Home page
72280
73281To define the layout of your Home page, include the following optimal parameters in each of your breakpoints:
0 commit comments