Skip to content

Commit e717ade

Browse files
OpinionatedHeronrm3l
OpinionatedHeron
and
rm3l
authored
chore: Updating theme params to reflect documentation (#225)
Co-authored-by: Armel Soro <asoro@redhat.com> Signed-off-by: Leanne Ahern <lahern@redhat.com>
1 parent 0a74257 commit e717ade

2 files changed

Lines changed: 155 additions & 120 deletions

File tree

‎configs/app-config/app-config.local.example.yaml‎

Lines changed: 21 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -14,22 +14,34 @@ app:
1414
# If using a different logo, replace these lines with your own image(s)
1515
# fullLogo: data:image/svg+xml;base64,your-image-goes-here==
1616
# - or -
17-
# fullLogo:
17+
# fullLogo:
1818
# dark: data:image/svg+xml;base64,your-image-in-dark-mode-goes-here==
1919
# light: data:image/svg+xml;base64,your-image-in-light-mode-goes-here==
2020
# iconLogo: data:image/svg+xml;base64,your-image-goes-here==
2121
fullLogoWidth: ${FULL_LOGO_WIDTH}
2222
theme:
2323
light:
24-
primaryColor: ${PRIMARY_LIGHT_COLOR}
25-
headerColor1: ${HEADER_LIGHT_COLOR_1}
26-
headerColor2: ${HEADER_LIGHT_COLOR_2}
27-
navigationIndicatorColor: ${NAV_INDICATOR_LIGHT_COLOR}
24+
palette:
25+
primary:
26+
main: ${PRIMARY_LIGHT_COLOR}
27+
navigation:
28+
indicator: ${NAV_INDICATOR_LIGHT_COLOR}
29+
pageTheme:
30+
default:
31+
backgroundColor:
32+
- ${HEADER_LIGHT_COLOR_1}
33+
- ${HEADER_LIGHT_COLOR_2}
2834
dark:
29-
primaryColor: ${PRIMARY_DARK_COLOR}
30-
headerColor1: ${HEADER_DARK_COLOR_1}
31-
headerColor2: ${HEADER_DARK_COLOR_2}
32-
navigationIndicatorColor: ${NAV_INDICATOR_DARK_COLOR}
35+
palette:
36+
primary:
37+
main: ${PRIMARY_DARK_COLOR}
38+
navigation:
39+
indicator: ${NAV_INDICATOR_DARK_COLOR}
40+
pageTheme:
41+
default:
42+
backgroundColor:
43+
- ${HEADER_DARK_COLOR_1}
44+
- ${HEADER_DARK_COLOR_2}
3345

3446
# Tech Radar Plugin Example - uncomment with plugin override to use
3547
# Replace URL with your own hosted json to visualize data in Tech Radar

‎configs/app-config/app-config.yaml‎

Lines changed: 134 additions & 111 deletions
Original file line numberDiff line numberDiff line change
@@ -22,112 +22,124 @@ app:
2222
# If using a different logo, replace these lines with your own image(s)
2323
# fullLogo: data:image/svg+xml;base64,your-image-goes-here==
2424
# - or -
25-
# fullLogo:
25+
# fullLogo:
2626
# dark: data:image/svg+xml;base64,your-image-in-dark-mode-goes-here==
2727
# light: data:image/svg+xml;base64,your-image-in-light-mode-goes-here==
2828
# iconLogo: data:image/svg+xml;base64,your-image-goes-here==
2929
fullLogoWidth: ${FULL_LOGO_WIDTH}
3030
theme:
3131
light:
32-
primaryColor: ${PRIMARY_LIGHT_COLOR}
33-
headerColor1: ${HEADER_LIGHT_COLOR_1}
34-
headerColor2: ${HEADER_LIGHT_COLOR_2}
35-
navigationIndicatorColor: ${NAV_INDICATOR_LIGHT_COLOR}
32+
palette:
33+
primary:
34+
main: ${PRIMARY_LIGHT_COLOR}
35+
navigation:
36+
indicator: ${NAV_INDICATOR_LIGHT_COLOR}
37+
pageTheme:
38+
default:
39+
backgroundColor:
40+
- ${HEADER_LIGHT_COLOR_1}
41+
- ${HEADER_LIGHT_COLOR_2}
3642
dark:
37-
primaryColor: ${PRIMARY_DARK_COLOR}
38-
headerColor1: ${HEADER_DARK_COLOR_1}
39-
headerColor2: ${HEADER_DARK_COLOR_2}
40-
navigationIndicatorColor: ${NAV_INDICATOR_DARK_COLOR}
43+
palette:
44+
primary:
45+
main: ${PRIMARY_DARK_COLOR}
46+
navigation:
47+
indicator: ${NAV_INDICATOR_DARK_COLOR}
48+
pageTheme:
49+
default:
50+
backgroundColor:
51+
- ${HEADER_DARK_COLOR_1}
52+
- ${HEADER_DARK_COLOR_2}
53+
4154
quickstart:
4255
# Quickstarts for all users (both new admins and new developers)
43-
- title: 'What is Developer Hub?'
44-
description: 'Learn what Developer Hub is, its purpose, and how to use it to discover, create, and manage software in your organization.'
45-
icon: 'developerHub'
46-
roles: ['admin', 'developer'] # Show to all users
56+
- title: "What is Developer Hub?"
57+
description: "Learn what Developer Hub is, its purpose, and how to use it to discover, create, and manage software in your organization."
58+
icon: "developerHub"
59+
roles: ["admin", "developer"] # Show to all users
4760
cta:
48-
text: 'Read the Introduction'
49-
link: '/docs/default/system/rhdh-local/intro/rhdh/' # Link points to a very custom location that only exists by default in RHDH Local
50-
- title: 'Navigate Your Way Around'
51-
description: 'The homepage gives links to important features and documentation. The topbar allows you to to search for anything, register new components, view your starred entities, and launch external apps.'
52-
icon: 'kind:location'
53-
roles: ['admin', 'developer']
61+
text: "Read the Introduction"
62+
link: "/docs/default/system/rhdh-local/intro/rhdh/" # Link points to a very custom location that only exists by default in RHDH Local
63+
- title: "Navigate Your Way Around"
64+
description: "The homepage gives links to important features and documentation. The topbar allows you to to search for anything, register new components, view your starred entities, and launch external apps."
65+
icon: "kind:location"
66+
roles: ["admin", "developer"]
5467
cta:
55-
text: 'Start Exploring'
56-
link: '/'
57-
- title: 'Browse The Software Catalog'
58-
description: 'The software catalog lets you see all the projects and components shared by development teams throughout your organization.'
59-
icon: 'catalog'
60-
roles: ['admin', 'developer'] # Show to both roles
68+
text: "Start Exploring"
69+
link: "/"
70+
- title: "Browse The Software Catalog"
71+
description: "The software catalog lets you see all the projects and components shared by development teams throughout your organization."
72+
icon: "catalog"
73+
roles: ["admin", "developer"] # Show to both roles
6174
cta:
62-
text: 'Open the Catalog'
63-
link: '/catalog'
64-
- title: 'Browse The ''Golden Path'' Templates'
65-
description: 'Golden path templates let you quickly create and customize software projects that follow your organization''s coding standards using simple wizard like forms. You can even develop and share templates of your own!'
66-
icon: 'scaffolder'
67-
roles: ['admin', 'developer'] # Show to both roles
75+
text: "Open the Catalog"
76+
link: "/catalog"
77+
- title: "Browse The 'Golden Path' Templates"
78+
description: "Golden path templates let you quickly create and customize software projects that follow your organization's coding standards using simple wizard like forms. You can even develop and share templates of your own!"
79+
icon: "scaffolder"
80+
roles: ["admin", "developer"] # Show to both roles
6881
cta:
69-
text: 'Browse the Templates'
70-
link: '/create'
71-
- title: 'Read Some TechDocs'
72-
description: 'Discover project documentation, architecture notes, and how-to guides in TechDocs.'
73-
icon: 'techdocs'
74-
roles: ['admin', 'developer']
82+
text: "Browse the Templates"
83+
link: "/create"
84+
- title: "Read Some TechDocs"
85+
description: "Discover project documentation, architecture notes, and how-to guides in TechDocs."
86+
icon: "techdocs"
87+
roles: ["admin", "developer"]
7588
cta:
76-
text: 'View the TechDocs'
77-
link: '/docs'
78-
- title: 'Explore APIs'
79-
description: 'Visit the APIs section to discover the APIs that have been added by our organization.'
80-
icon: 'kind:api'
81-
roles: ['admin', 'developer'] # Show to both roles
89+
text: "View the TechDocs"
90+
link: "/docs"
91+
- title: "Explore APIs"
92+
description: "Visit the APIs section to discover the APIs that have been added by our organization."
93+
icon: "kind:api"
94+
roles: ["admin", "developer"] # Show to both roles
8295
cta:
83-
text: 'View the APIs'
84-
link: '/api-docs'
85-
- title: 'Add Software To The Catalog'
86-
description: 'You can register existing Backstage components into the catalog using catalog-info.yaml files. Alternatively, you could use our Bulk Import tool to register multiple components at once.'
87-
icon: 'add'
88-
roles: ['admin', 'developer'] # Show to both roles
96+
text: "View the APIs"
97+
link: "/api-docs"
98+
- title: "Add Software To The Catalog"
99+
description: "You can register existing Backstage components into the catalog using catalog-info.yaml files. Alternatively, you could use our Bulk Import tool to register multiple components at once."
100+
icon: "add"
101+
roles: ["admin", "developer"] # Show to both roles
89102
cta:
90-
text: 'Register a Component'
91-
link: '/catalog-import'
92-
- title: 'Personalize Your Experience'
93-
description: 'Customize Developer Hub to match your preferences. Toggle dark mode, adjust your theme, and configure settings to create your ideal workspace.'
94-
icon: 'manageAccounts'
95-
roles: ['admin', 'developer'] # Show to all users
103+
text: "Register a Component"
104+
link: "/catalog-import"
105+
- title: "Personalize Your Experience"
106+
description: "Customize Developer Hub to match your preferences. Toggle dark mode, adjust your theme, and configure settings to create your ideal workspace."
107+
icon: "manageAccounts"
108+
roles: ["admin", "developer"] # Show to all users
96109
cta:
97-
text: 'Open Settings'
98-
link: '/settings'
99-
- title: 'Learn New Skills'
100-
description: 'Discover curated learning paths designed to help you expand your knowledge and skills in various technologies.'
101-
icon: 'school'
102-
roles: ['admin', 'developer'] # Show to both roles
110+
text: "Open Settings"
111+
link: "/settings"
112+
- title: "Learn New Skills"
113+
description: "Discover curated learning paths designed to help you expand your knowledge and skills in various technologies."
114+
icon: "school"
115+
roles: ["admin", "developer"] # Show to both roles
103116
cta:
104-
text: 'View Learning Paths'
105-
link: '/learning-paths'
106-
- title: 'Star Your Favorite Items'
107-
description: 'Click the Star icon on any Catalog entity, API, or anywhere else you see a star. Your starred items appear in the top navigation bar for quick access. Try it now by adding the RHDH Local System to your starred items list.'
108-
icon: 'star'
109-
roles: ['admin', 'developer']
117+
text: "View Learning Paths"
118+
link: "/learning-paths"
119+
- title: "Star Your Favorite Items"
120+
description: "Click the Star icon on any Catalog entity, API, or anywhere else you see a star. Your starred items appear in the top navigation bar for quick access. Try it now by adding the RHDH Local System to your starred items list."
121+
icon: "star"
122+
roles: ["admin", "developer"]
110123
cta:
111-
text: 'Learn More'
112-
link: '/catalog/default/system/rhdh-local'
124+
text: "Learn More"
125+
link: "/catalog/default/system/rhdh-local"
113126

114127
# Quickstarts just for admins
115-
- title: 'View Your Platform Adoption Metrics'
116-
description: 'See how your developers are using Developer Hub''s many tools and features.'
117-
icon: 'chart'
118-
roles: ['admin']
128+
- title: "View Your Platform Adoption Metrics"
129+
description: "See how your developers are using Developer Hub's many tools and features."
130+
icon: "chart"
131+
roles: ["admin"]
119132
cta:
120-
text: 'Open Adoption Insights'
121-
link: '/adoption-insights'
122-
- title: 'Manage and Install Plugins'
123-
description: 'Browse the Extensions Catalog to discover, install, and manage plugins that extend Developer Hub''s functionality.'
124-
icon: 'storefront'
125-
roles: ['admin'] # Show only to admins
133+
text: "Open Adoption Insights"
134+
link: "/adoption-insights"
135+
- title: "Manage and Install Plugins"
136+
description: "Browse the Extensions Catalog to discover, install, and manage plugins that extend Developer Hub's functionality."
137+
icon: "storefront"
138+
roles: ["admin"] # Show only to admins
126139
cta:
127-
text: 'Open Extensions Catalog'
128-
link: '/extensions/catalog'
140+
text: "Open Extensions Catalog"
141+
link: "/extensions/catalog"
129142

130-
131143
backend:
132144
listen:
133145
port: 7007
@@ -140,24 +152,24 @@ backend:
140152
methods: [GET, HEAD, PATCH, POST, PUT, DELETE]
141153
credentials: true
142154
csp:
143-
upgrade-insecure-requests: false
144-
img-src:
145-
- "'self'"
146-
- "data:"
147-
- "https://quay.io"
148-
- "https://*.quay.io"
149-
- "https://img.freepik.com"
150-
- "https://cdn.dribbble.com"
151-
- "https://avatars.githubusercontent.com"
152-
script-src:
153-
- "'self'"
154-
- "'unsafe-eval'"
155-
- "https://cdn.jsdelivr.net"
156-
# comment out the following 'database' section to use the PostgreSQL database
155+
upgrade-insecure-requests: false
156+
img-src:
157+
- "'self'"
158+
- "data:"
159+
- "https://quay.io"
160+
- "https://*.quay.io"
161+
- "https://img.freepik.com"
162+
- "https://cdn.dribbble.com"
163+
- "https://avatars.githubusercontent.com"
164+
script-src:
165+
- "'self'"
166+
- "'unsafe-eval'"
167+
- "https://cdn.jsdelivr.net"
168+
# comment out the following 'database' section to use the PostgreSQL database
157169
database:
158170
client: better-sqlite3
159-
connection: ':memory:'
160-
# static auth provider for development and testing purposes. This is not meant for production use.
171+
connection: ":memory:"
172+
# static auth provider for development and testing purposes. This is not meant for production use.
161173
auth:
162174
externalAccess:
163175
- type: static
@@ -171,7 +183,18 @@ catalog:
171183
# processingInterval: { seconds: 30 }
172184

173185
rules:
174-
- allow: [Component, API, Location, Template, Domain, User, Group, System, Resource]
186+
- allow:
187+
[
188+
Component,
189+
API,
190+
Location,
191+
Template,
192+
Domain,
193+
User,
194+
Group,
195+
System,
196+
Resource,
197+
]
175198

176199
locations:
177200
- type: file
@@ -223,21 +246,21 @@ techdocs:
223246
dynamicPlugins:
224247
frontend:
225248
default.main-menu-items:
226-
menuItems:
227-
default.help:
228-
title: RHDH Guide
229-
icon: techdocs
230-
priority: 5
231-
to: /catalog/default/system/rhdh-local/docs
232-
enabled: true
249+
menuItems:
250+
default.help:
251+
title: RHDH Guide
252+
icon: techdocs
253+
priority: 5
254+
to: /catalog/default/system/rhdh-local/docs
255+
enabled: true
233256

234257
proxy:
235258
endpoints:
236-
'/quay/api':
237-
target: 'https://quay.io'
259+
"/quay/api":
260+
target: "https://quay.io"
238261
credentials: require
239262
headers:
240-
X-Requested-With: 'XMLHttpRequest'
263+
X-Requested-With: "XMLHttpRequest"
241264
# Uncomment and use the Authorization header below to access a private Quay
242265
# Repository using a token. Refer to the "Applications and Tokens" section
243266
# at https://docs.quay.io/api/ to find the instructions to generate a token
@@ -248,7 +271,7 @@ proxy:
248271

249272
quay:
250273
# The UI url for Quay, used to generate the link to Quay
251-
uiUrl: 'https://quay.io'
274+
uiUrl: "https://quay.io"
252275

253276
# ==============================================================================
254277
# Developer Lightspeed Plugin Configuration
@@ -261,7 +284,7 @@ lightspeed:
261284
# These appear as suggested questions/prompts to help users get started
262285
# If not provided, the plugin uses built-in default prompts
263286
prompts:
264-
- title: 'Getting Started with Red Hat Developer Hub'
287+
- title: "Getting Started with Red Hat Developer Hub"
265288
message: Can you guide me through the first steps to start using Developer Hub as a developer, like exploring the Software Catalog and adding my service?
266289

267290
# OPTIONAL: Port for the Lightspeed backend service

0 commit comments

Comments
 (0)