Skip to content

Commit 761e50e

Browse files
authored
feat: Add quickstart guides for users and admins (#125)
1 parent 42acc44 commit 761e50e

File tree

1 file changed

+90
-0
lines changed

1 file changed

+90
-0
lines changed

configs/app-config/app-config.yaml

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,96 @@ app:
3838
headerColor1: ${HEADER_DARK_COLOR_1}
3939
headerColor2: ${HEADER_DARK_COLOR_2}
4040
navigationIndicatorColor: ${NAV_INDICATOR_DARK_COLOR}
41+
quickstart:
42+
# 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
47+
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']
54+
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
61+
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
68+
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']
75+
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
82+
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
89+
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
96+
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
103+
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']
110+
cta:
111+
text: 'Learn More'
112+
link: '/catalog/default/system/rhdh-local'
113+
114+
# 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']
119+
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
126+
cta:
127+
text: 'Open Extensions Catalog'
128+
link: '/extensions/catalog'
129+
130+
41131
backend:
42132
listen:
43133
port: 7007

0 commit comments

Comments
 (0)