Skip to content

Commit 56194e7

Browse files
authored
Merge pull request #2797 from port-labs/PORTN-3660-add-organization-announcement-banner-feature
Portn 3660 add organization announcement banner feature
2 parents e44bfb6 + a2e798f commit 56194e7

File tree

1 file changed

+23
-1
lines changed

1 file changed

+23
-1
lines changed

docs/customization.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ sidebar_class_name: custom-sidebar-item sidebar-menu-customization
77

88
# Customization & accessibility
99

10-
Port offers various customization options to help you tailor the developer portal to your organization's branding and style.
10+
Port offers various customization options to help you tailor the developer portal to your organization's branding and style as well as communicate important information to your users.
1111

1212
## Portal customization
1313

@@ -37,6 +37,28 @@ To change them:
3737
- The title is limited to 30 characters.
3838
- The logo URL must be a valid public link (e.g. `https://example.com/logo.png`).
3939

40+
### Add an announcement banner
41+
42+
Organization admins can configure an **announcement banner** that appears at the top of the portal for all users. The banner can be enabled or disabled at any time.
43+
44+
Users can dismiss the banner and it will remain hidden until the admin updates the announcement.
45+
46+
To add the banner:
47+
48+
1. Go to the [Builder page](https://app.getport.io/settings/data-model) of your portal.
49+
50+
2. Click on `Organization settings` in the sidebar.
51+
52+
3. Open the `Announcment` tab, and toggle `Enable announcement` to turn it on.
53+
54+
4. Fill in the banner details:
55+
- **Announcement:** The text that will appear in the banner. (Maximum 300 characters)
56+
- **Color:** Choose a color for your banner. Currently, the available colors are **blue** and **red**.
57+
- **Link (optional):** Add a URL to make the banner clickable and direct users to the provided link. (Maximum 300 characters)
58+
59+
5. Click `Save`.
60+
61+
4062
### Dark mode
4163

4264
To change the theme of the portal to dark mode:

0 commit comments

Comments
 (0)