Skip to content

Commit 357cd43

Browse files
committed
Create System Banners Documentation
Document the new system banners enterprise only feature for organizations to communicate with their staff via announcement banners
1 parent ab80023 commit 357cd43

File tree

3 files changed

+33
-0
lines changed

3 files changed

+33
-0
lines changed

data/nav.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -314,6 +314,8 @@
314314
path: "team-management"
315315
- name: "User and team permissions"
316316
path: "team-management/permissions"
317+
- name: "System banners"
318+
path: "team-management/system-banners"
317319
- name: "Governance"
318320
children:
319321
- name: "Overview"

pages/team_management.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,5 @@ toc: false
77
Team management is fundamental in CI/CD tools to ensure streamlined processes, proper access controls, and efficient collaboration. Buildkite provides features for your team management needs:
88

99
- [User and team permissions](/docs/team-management/permissions)
10+
- [System banners](/docs/team-management/system-banners) (enterprise only)
1011
- [Managing API access tokens](/docs/apis/managing-api-tokens) (under the APIs section)
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
keywords: docs, tutorials, 2fa
3+
---
4+
5+
# System banners (enterprise only)
6+
7+
Organization owners can create announcement banners for the organization. Banners
8+
will be displayed to all organization members at the top of every page in the
9+
organization.
10+
11+
You can use Markdown to format your message and link to other documentation
12+
which you may have.
13+
14+
## Steps to creating a banner
15+
16+
- You must be logged in as an Administrator
17+
- Visit the Organization's [settings page]
18+
- Add a message to the **System banners** panel
19+
- Click **Save Banner**
20+
21+
[settings page]: <https://buildkite.com/organizations/~/settings>
22+
23+
## Programmatically creating a system banner
24+
25+
You can create a system banner programmatically via the GraphQL API.
26+
27+
Please review the GraphQL [cookbook] on instructions on how to create
28+
a banner via the API.
29+
30+
[cookbook]: </docs/apis/graphql/cookbooks/organizations#create-a-banner>

0 commit comments

Comments
 (0)