Ce contenu n'est pas disponible dans la langue sélectionnée.
Chapter 12. Customizing the Home page
When using the app-config
, you can do the following:
- Customize and extend the default Home page layout with additional cards that appear based on the plugins you have installed and enabled.
- Change quick access links.
Add, reorganize, and remove the following available cards:
- Search bar
- Quick access
- Headline
- Markdown
- Placeholder
- Catalog starred entities
- Featured docs
12.1. Customizing the Home page cards Copier lienLien copié sur presse-papiers!
As an administrator, you can customize the layout and content of the Home page to create a tailored user experience. This includes integrating various specialized cards into the primary view.
The Home page layout uses a 12-column grid system. You can precisely define the position (x), width (w), and height (h) for each card across multiple screen breakpoints:
- Extra-large (xl)
- Large (lg)
- Medium (md)
- Small (sm)
- Extra-small (xs)
- Extra-extra-small (xxs)
The default Home page is as shown in the following app-config.yaml
file configuration:
Prerequisites
-
You have administrative access and can modify the
app-config.yaml
file for dynamic plugin configurations.
Procedure
Configure different cards for your Home page in Red Hat Developer Hub as shown in the following code:
- Search
You can use the SearchBar card to provide essential search functionality directly on the Home page.
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Expand Table 12.1. Available props Prop Default Description path
/search
Override the linked search path if needed
queryParam
query
Override the search query parameter name if needed
- Quick access
You can use the QuickAccessCard card to function as a customizable shortcut panel.
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Expand Table 12.2. Available props Prop Default Description title
Quick Access
Override the linked search path if needed
path
none
Override the search query parameter name if needed
- Headline
You can use the Headline card to display important information.
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Expand Table 12.3. Available props Prop Default Description title
none
Title
- Markdown
You can use the Markdown card to display richly formatted content directly within the Home page layout. This card uses Markdown syntax to present structured information, such as lists and links (documentation and plugin repositories).
Copy to Clipboard Copied! Toggle word wrap Toggle overflow - Placeholder
You can use the Placeholder card as a utility element for reserving space or for layout testing on the Home page.
Copy to Clipboard Copied! Toggle word wrap Toggle overflow - Catalog starred entities
You can use the CatalogStarredEntitiesCard card to provide a dedicated space on the Home page for users to view catalog entities that they have marked as starred.
Copy to Clipboard Copied! Toggle word wrap Toggle overflow - Featured docs
You can use the FeaturedDocsCard card as a way to highlight specific documentation within Red Hat Developer Hub, as it is available for deployment on the Home page.
Copy to Clipboard Copied! Toggle word wrap Toggle overflow - EntitySection
You can use the EntitySection card to create a visually engaging section that highlights catalog entities of various kinds, such as
Component
,API
,Resource
, andSystem
.Copy to Clipboard Copied! Toggle word wrap Toggle overflow - OnboardingSection
You can use the OnboardingSection card to quickly discover learning resources within RHDH.
Copy to Clipboard Copied! Toggle word wrap Toggle overflow - TemplateSection
You can use the TemplateSection card to quickly explore and initiate software templates in RHDH.
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
12.2. Defining the layout of the Red Hat Developer Hub Home page Copier lienLien copié sur presse-papiers!
The Home page uses a 12-column grid to position your cards. You can use the optimal parameters to define the layout of your Developer Hub Home page.
Prerequisites
Include the following optimal parameters in each of your breakpoints:
- width (w)
- height (h)
- position (x and y)
Procedure
Configure your Developer Hub
app-config.yaml
configuration file by choosing one of the following options:- Use the full space on smaller windows and half of the space on larger windows as follows:
-
Show the cards side by side by defining the
x
parameter as shown in the following example:
However, you can see a second card below this card by default.
-
Show the cards in three columns by defining the
x
parameter as shown in the following example: