Skip to content

Commit 8196fd1

Browse files
feat(docs) Add feature guide doc for the new custom home page (datahub-project#14256)
Co-authored-by: Maggie Hays <maggiem.hays@gmail.com>
1 parent ace1ebd commit 8196fd1

File tree

2 files changed

+253
-0
lines changed

2 files changed

+253
-0
lines changed

docs-website/sidebars.js

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -190,6 +190,11 @@ module.exports = {
190190
},
191191
],
192192
},
193+
{
194+
label: "Custom Home Page",
195+
type: "doc",
196+
id: "docs/features/feature-guides/custom-home-page",
197+
},
193198
{
194199
label: "Data Contract",
195200
type: "doc",
Lines changed: 248 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,248 @@
1+
---
2+
title: Custom Home Page
3+
---
4+
5+
import FeatureAvailability from '@site/src/components/FeatureAvailability';
6+
7+
# Custom Home Page
8+
9+
<FeatureAvailability/>
10+
11+
DataHub's **Custom Home Page** empowers organizations and individual users to create personalized, modular home page experiences that put the most relevant data assets and information front and center.
12+
13+
<p align="center">
14+
<img
15+
width="70%"
16+
src="https://raw.githubusercontent.com/datahub-project/static-assets/refs/heads/main/imgs/home/default-home-page.png"
17+
alt="Default custom home page"/>
18+
</p>
19+
20+
## Why Use the Custom Home Page?
21+
22+
The Custom Home Page transforms how your team interacts with DataHub by enabling you to:
23+
24+
- **Reduce Time to Insight**: Surface the most critical data assets, domains, and resources directly on your home page for instant access
25+
- **Personalize Your Workflow**: Create a home page experience tailored to your specific role, projects, and data needs
26+
- **Improve Data Discoverability**: Highlight important collections, documentation, and quick links that help your team find what they need faster
27+
- **Standardize Organization Views**: Administrators can create consistent default experiences while still allowing individual customization
28+
29+
Whether you're a data analyst who needs quick access to specific dashboards, a data engineer focused on particular domains, or an administrator wanting to promote data governance resources, the Custom Home Page adapts to your workflow.
30+
31+
## What's Included
32+
33+
The Custom Home Page consists of **modules** that you can arrange in rows of up to 3 modules each. You can choose from:
34+
35+
### Default Modules
36+
37+
- **Your Assets**: Data assets that you own, giving you quick access to the assets you're responsible for
38+
- **Your Subscriptions**: Assets you've subscribed to for updates and notifications
39+
- **Domains**: A selection of the most-used domains in your organization for easy navigation
40+
41+
### Custom Modules
42+
43+
- **Quick Link**: Links to important external references like documentation sites, dashboards, or tools
44+
- **Collection**: Curated collections of data assets that you want to highlight for easy discoverability
45+
- **Documentation**: Pinned documentation that DataHub users should see on their home page
46+
- **Hierarchy**: A top-down view of assets organized by selected Domains or Glossary Terms/Term Groups
47+
48+
### Organization Announcements
49+
50+
Important announcements from your organization appear above all modules, with the ability for users to individually dismiss them.
51+
52+
<p align="center">
53+
<img
54+
width="70%"
55+
src="https://raw.githubusercontent.com/datahub-project/static-assets/refs/heads/main/imgs/home/module-examples.png"
56+
alt="Module examples"/>
57+
</p>
58+
59+
### Default Setup
60+
61+
When you upgrade to this version, your default home page will automatically include:
62+
63+
- Your organization's existing pinned links at the top
64+
- Row 1: Your Assets and Your Subscriptions modules
65+
- Row 2: Domains module
66+
67+
## Personalizing the Home Page
68+
69+
When you begin customizing your home page, you'll "fork" from your organization's default to create your own personal version. This means your changes won't affect what other users see, and you can always return to the organization default if needed.
70+
71+
### Add New Modules
72+
73+
Click **"Add Module"** to browse and select from available module types. Custom module can be configured with specific settings:
74+
75+
<p align="center">
76+
<img
77+
width="70%"
78+
src="https://raw.githubusercontent.com/datahub-project/static-assets/refs/heads/main/imgs/home/add-module-menu.png"
79+
alt="Add module menu"/>
80+
</p>
81+
82+
### Rearrange Modules
83+
84+
Drag and drop modules to reorder them within rows or move them between rows. You can have up to 3 modules per row.
85+
86+
<p align="center">
87+
<img
88+
width="70%"
89+
src="https://raw.githubusercontent.com/datahub-project/static-assets/refs/heads/main/imgs/home/move-module.png"
90+
alt="Move module example"/>
91+
</p>
92+
93+
### Edit Existing Modules
94+
95+
Click the **edit icon** on any module to modify its settings, title, or content. Currently, editing is only available for custom modules.
96+
97+
<p align="center">
98+
<img
99+
width="70%"
100+
src="https://raw.githubusercontent.com/datahub-project/static-assets/refs/heads/main/imgs/home/edit-module-modal.png"
101+
alt="Edit module modal"/>
102+
</p>
103+
104+
### Remove Modules
105+
106+
Click the **remove icon** on any module to delete it from your home page. Don't worry - you can always add default modules back later.
107+
108+
<p align="center">
109+
<img
110+
width="70%"
111+
src="https://raw.githubusercontent.com/datahub-project/static-assets/refs/heads/main/imgs/home/edit-module-menu.png"
112+
alt="Edit module menu"/>
113+
</p>
114+
115+
### Reset to Default
116+
117+
If you want to return to your organization's default home page:
118+
119+
1. Click the **settings icon** in the bottom right corner
120+
2. Select **"Reset to Default Home Page"**
121+
3. Confirm that you want to remove your personal customizations
122+
123+
This will delete your personal home page template and return you to the organization default.
124+
125+
<p align="center">
126+
<img
127+
width="70%"
128+
src="https://raw.githubusercontent.com/datahub-project/static-assets/refs/heads/main/imgs/home/reset-to-default-menu.png"
129+
alt="Option to reset to default menu"/>
130+
</p>
131+
132+
<p align="center">
133+
<img
134+
width="70%"
135+
src="https://raw.githubusercontent.com/datahub-project/static-assets/refs/heads/main/imgs/home/confirm-reset-modal.png"
136+
alt="Confirm reset to default modal"/>
137+
</p>
138+
139+
:::tip
140+
Even when you have a personal home page, you can always grab modules from the default home page to add to your personal view. This lets you stay up-to-date with organizational standards while maintaining your customizations.
141+
:::
142+
143+
## Configuring the Default Home Page
144+
145+
Users with the `MANAGE_HOME_PAGE_TEMPLATES` privilege (administrators by default) can customize the default home page that all users see when they first log in.
146+
147+
### Editing the Organization Default
148+
149+
To modify the default home page for your organization:
150+
151+
1. Click the **settings icon** in the bottom right corner of your home page
152+
2. Select **"Edit Organization Default"**
153+
154+
<p align="center">
155+
<img
156+
width="70%"
157+
src="https://raw.githubusercontent.com/datahub-project/static-assets/refs/heads/main/imgs/home/edit-org-default-menu.png"
158+
alt="Edit org default menu"/>
159+
</p>
160+
161+
When you enter organization default edit mode, you'll see the current default template. Any changes you make here will:
162+
163+
- **Save directly to the organization default**: Changes take effect immediately for all users using the default template
164+
- **Appear for new users**: Anyone who hasn't customized their home page will see your updates
165+
- **Not override personal templates**: Users who have created personal home pages will continue to see their customized versions
166+
167+
<p align="center">
168+
<img
169+
width="70%"
170+
src="https://raw.githubusercontent.com/datahub-project/static-assets/refs/heads/main/imgs/home/edit-org-default-page.png"
171+
alt="Edit org default page"/>
172+
</p>
173+
174+
### Managing Default Modules
175+
176+
As an administrator editing the organization default, you can:
177+
178+
- Add modules that provide value to most users in your organization
179+
- Remove modules that aren't relevant to your team's workflow
180+
- Rearrange modules to prioritize the most important information
181+
- Update module configurations (like which domains to feature)
182+
183+
### Best Practices for Default Templates
184+
185+
When configuring your organization's default home page:
186+
187+
- **Include broadly useful modules**: Choose modules that provide value to most users, like "Your Assets" and "Domains"
188+
- **Feature organizational resources**: Use Quick Link and Documentation modules to promote important company resources
189+
- **Keep it focused**: A cluttered default page can overwhelm new users - aim for 3-6 well-chosen modules
190+
- **Update regularly**: Review and refresh the default template periodically to ensure it stays relevant
191+
192+
:::note
193+
Administrators can have both the ability to edit the organization default AND maintain their own personal home page customizations. The two are independent.
194+
:::
195+
196+
## Next Steps
197+
198+
Now that you understand how to customize your home page experience:
199+
200+
1. **Start with small changes**: Try rearranging existing modules or adding a Quick Link to see how the interface works
201+
2. **Experiment with modules**: Each module type offers different ways to surface important information
202+
3. **Gather feedback**: If you're an administrator, ask users what they'd find most valuable on the default home page
203+
4. **Iterate over time**: Home page needs may change as your team and data landscape evolve
204+
205+
The Custom Home Page is designed to grow with your organization's needs, providing both the flexibility for individual workflows and the consistency that administrators need to promote important resources and best practices.
206+
207+
## Relevant APIs
208+
209+
### Upserting a Template
210+
211+
A template is what is displayed on your home page. It includes a list of rows, each row contains a list of module urns.
212+
213+
```graphql
214+
mutation upsertPageTemplate {
215+
upsertPageTemplate(
216+
input: {
217+
rows: [{ modules: ["urn:li:dataHubPageModule:your_assets"] }]
218+
scope: GLOBAL
219+
surfaceType: HOME_PAGE
220+
}
221+
) {
222+
urn
223+
}
224+
}
225+
```
226+
227+
### Upserting a Module
228+
229+
A module is each individual "widget" shown on the home page. These exist in the context of a template
230+
231+
```graphql
232+
mutation upsertPageModule {
233+
upsertPageModule(
234+
input: {
235+
name: "My Custom Module"
236+
type: RICH_TEXT
237+
scope: PERSONAL
238+
params: {
239+
richTextParams: {
240+
content: "This is the content of my documentation module"
241+
}
242+
}
243+
}
244+
) {
245+
urn
246+
}
247+
}
248+
```

0 commit comments

Comments
 (0)