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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Added quickstart guides for users and admins in app-config.yaml. This PR will reconfigure the Quickstart docked menu so that it offers a broad selection of suggestions for new users (both admins and developers) to try in order to familiarize themselves with Red Hat Developer Hub and its major features. There is one optional (commented) item intended for users of Developer Lightspeed.
Which issue(s) does this PR fix or relate to
Fixes #issue_number
PR acceptance criteria
Tests updated and passing
Documentation updated
Built-in TechDocs updated if needed. Note that TechDocs changes may need to be reviewed by a Product Manager and/or Architect to ensure content accuracy, clarity, and alignment with user needs.
How to test changes / Special notes to the reviewer
Simply boot RHDH Local, you should see the Quickstart docked menu on the right hand side of the screen. the menu has been reconfigured to offer a multitude of tips and suggestions.
Added quickstart guides for users and admins in app-config.yaml. This PR will reconfigure the Quickstart docked menu so that it offers a broad selection of suggestions for new users (both admins and developers) to try in order to familiarize themselves with Red Hat Developer Hub and its major features. There is one optional (commented) item intended for users of Developer Lightspeed.
The quickstart item "Read the Introduction" links to a very environment-specific TechDocs path. Validate that this route exists in all expected deployments, or guard it behind a feature flag/document the prerequisite.
link: '/docs/default/system/rhdh-local/intro/rhdh/'# Link points to a very custom location that only exists by default in RHDH Local
- title: 'Navigate Your Way Around'
The new quickstart keys and icon identifiers (for example, icons like 'developerHub', 'Rbac', 'storefront', and routes such as '/extensions/catalog' and '/adoption-insights') are not present in the referenced configuration examples. Verify that these icons are registered and that the linked routes are enabled by corresponding plugins in your deployment. (Ref 1, Ref 4)
quickstart:
# Quickstarts for all users (both new admins and new developers)
- title: 'What is Developer Hub?'description: 'Learn what Developer Hub is, its purpose, and how to use it to discover, create, and manage software in your organization.'icon: 'developerHub'roles: ['admin', 'developer'] # Show to all userscta:
text: 'Read the Introduction'link: '/docs/default/system/rhdh-local/intro/rhdh/'# Link points to a very custom location that only exists by default in RHDH Local
- title: 'Navigate Your Way Around'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.'icon: 'kind:location'roles: ['admin', 'developer']cta:
text: 'Start Exploring'link: '/'
- title: 'Browse The Software Catalog'description: 'The software catalog lets you see all the projects and components shared by development teams throughout your organization.'icon: 'catalog'roles: ['admin', 'developer'] # Show to both rolescta:
text: 'Open the Catalog'link: '/catalog'
- title: 'Browse The ''Golden Path'' Templates'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!'icon: 'scaffolder'roles: ['admin', 'developer'] # Show to both rolescta:
text: 'Browse the Templates'link: '/create'
- title: 'Read Some TechDocs'description: 'Discover project documentation, architecture notes, and how-to guides in TechDocs.'icon: 'techdocs'roles: ['admin', 'developer']cta:
text: 'View the TechDocs'link: '/docs'
- title: 'Explore APIs'description: 'Visit the APIs section to discover the APIs that have been added by our organization.'icon: 'kind:api'roles: ['admin', 'developer'] # Show to both rolescta:
text: 'View the APIs'link: '/api-docs'# Uncomment if you're using Developer Lightspeed in RHDH Local...# - title: 'Ask Lightspeed To Help You'# description: 'Try Developer Lightspeed, the virtual assistant for everyday developer tasks — ask for summaries, troubleshoot issues, find docs, and more.'# icon: 'LightspeedIcon'# roles: ['admin', 'developer']# cta:# text: 'Open Developer Lightspeed'# link: '/lightspeed'
- title: 'Add Software To The Catalog'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.'icon: 'add'roles: ['admin', 'developer'] # Show to both rolescta:
text: 'Register a Component'link: '/catalog-import'
- title: 'Personalize Your Experience'description: 'Customize Developer Hub to match your preferences. Toggle dark mode, adjust your theme, and configure settings to create your ideal workspace.'icon: 'manageAccounts'roles: ['admin', 'developer'] # Show to all userscta:
text: 'Open Settings'link: '/settings'
- title: 'Learn New Skills'description: 'Discover curated learning paths designed to help you expand your knowledge and skills in various technologies.'icon: 'school'roles: ['admin', 'developer'] # Show to both rolescta:
text: 'View Learning Paths'link: '/learning-paths'
- title: 'Star Your Favorite Items'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.'icon: 'star'roles: ['admin', 'developer']cta:
text: 'Learn More'link: '/catalog/default/system/rhdh-local'# Quickstarts just for admins
- title: 'Manage Developer Roles and Permissions'description: 'As an admin, you can manage roles and permissions for users in the system to ensure proper access control.'icon: 'Rbac'roles: ['admin'] # Show only to adminscta:
text: 'Role Based Access Control'link: '/rbac'
- title: 'View Your Platform Adoption Metrics'description: 'See how your developers are using Developer Hub''s many tools and features.'icon: 'chart'roles: ['admin']cta:
text: 'Open Adoption Insights'link: '/adoption-insights'
- title: 'Manage and Install Plugins'description: 'Browse the Extensions Catalog to discover, install, and manage plugins that extend Developer Hub''s functionality.'icon: 'storefront'roles: ['admin'] # Show only to adminscta:
text: 'Open Extensions Catalog'link: '/extensions/catalog'backend:
Reference reasoning: The referenced app-config examples focus on standard Backstage/RHDH settings (app title, backend/auth, providers) and do not define UI quickstart sections, custom icons, or the routes used here. Ensure parity with deployed features by aligning with configured plugins and documented endpoints from the existing configs.
Move the quickstart definitions from app-config.yaml to a separate content file. This change separates UI content from application configuration, which improves modularity and simplifies future maintenance.
quickstart:
# Quickstarts for all users (both new admins and new developers)
- title: 'What is Developer Hub?'description: 'Learn what Developer Hub is, its purpose, and how to use it to discover, create, and manage software in your organization.'icon: 'developerHub'roles: ['admin', 'developer'] # Show to all userscta:
text: 'Read the Introduction'link: '/docs/default/system/rhdh-local/intro/rhdh/'# Link points to a very custom location that only exists by default in RHDH Local
- title: 'Navigate Your Way Around'... (clipped 93 lines)
Solution Walkthrough:
Before:
# configs/app-config/app-config.yamlapp:
# ... other app configsquickstart:
- title: 'What is Developer Hub?'description: 'Learn what Developer Hub is, its purpose, and how to use it...'icon: 'developerHub'roles: ['admin', 'developer']cta:
text: 'Read the Introduction'link: '/docs/default/system/rhdh-local/intro/rhdh/'# ... many more quickstart items embedded directly in the config
After:
# configs/app-config/app-config.yamlapp:
# ... other app configsquickstart:
# Reference to an external content file# The implementation would need to support loading from a path.path: './quickstarts.yaml'# configs/quickstarts.yaml (new file)
- title: 'What is Developer Hub?'description: 'Learn what Developer Hub is, its purpose, and how to use it...'icon: 'developerHub'roles: ['admin', 'developer']cta:
text: 'Read the Introduction'link: '/docs/default/system/rhdh-local/intro/rhdh/'# ... all other quickstart items
Suggestion importance[1-10]: 8
__
Why: This is a strong architectural suggestion that correctly identifies the issue of coupling UI content with application configuration, which impacts long-term maintainability and scalability.
Medium
General
Fix incorrect quoting in title
In the quickstart title, replace the escaped single quotes ('') around 'Golden Path' with double quotes (") for better formatting.
-- title: 'Browse The ''Golden Path'' Templates'+- title: 'Browse The "Golden Path" Templates'
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!'
icon: 'scaffolder'
roles: ['admin', 'developer'] # Show to both roles
cta:
text: 'Browse the Templates'
link: '/create'
Apply / Chat
Suggestion importance[1-10]: 2
__
Why: The suggestion correctly explains YAML string escaping, but the original code is valid and produces a single-quoted phrase. Changing it to use double quotes is a minor stylistic preference, not a bug fix.
Not sure if RBAC is on by default, so maybe we could comment out that one as well as Lightspeed?
Are you referring to the Manage Developer Roles and Permissions quickstart link? If so, yes, I guess should be commented out as well, as I think RBAC is disabled by default for RHDH Local.
Not sure if RBAC is on by default, so maybe we could comment out that one as well as Lightspeed?
Are you referring to the Manage Developer Roles and Permissions quickstart link? If so, yes, I guess should be commented out as well, as I think RBAC is disabled by default for RHDH Local.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
rhdh-qodo-merge
bot
added
Review effort 2/5
documentation
Description
Added quickstart guides for users and admins in app-config.yaml. This PR will reconfigure the Quickstart docked menu so that it offers a broad selection of suggestions for new users (both admins and developers) to try in order to familiarize themselves with Red Hat Developer Hub and its major features. There is one optional (commented) item intended for users of Developer Lightspeed.
Which issue(s) does this PR fix or relate to
PR acceptance criteria
How to test changes / Special notes to the reviewer
Simply boot RHDH Local, you should see the Quickstart docked menu on the right hand side of the screen. the menu has been reconfigured to offer a multitude of tips and suggestions.
