Skip to content

Commit

Permalink
Create System Banners Documentation
Browse files Browse the repository at this point in the history
Document the new system banners enterprise only feature
for organizations to communicate with their staff via
announcement banners
  • Loading branch information
jameshill committed Sep 20, 2023
1 parent 81e1f21 commit 0987fb9
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 0 deletions.
2 changes: 2 additions & 0 deletions data/nav.yml
Original file line number Diff line number Diff line change
Expand Up @@ -314,6 +314,8 @@
path: "team-management"
- name: "User and team permissions"
path: "team-management/permissions"
- name: "System banners"
path: "team-management/system-banners"
- name: "Governance"
children:
- name: "Overview"
Expand Down
1 change: 1 addition & 0 deletions pages/team_management.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,5 @@ toc: false
Managing users and teams in CI/CD is fundamental to collaboration, streamlined processes, and ensuring adequate access controls. Buildkite provides features to manage team access:

- [User and team permissions](/docs/team-management/permissions)
- [System banners](/docs/team-management/system-banners) (enterprise only)
- [Managing API access tokens](/docs/apis/managing-api-tokens) (under the APIs section)
30 changes: 30 additions & 0 deletions pages/team_management/system_banners.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
keywords: docs, tutorials, 2fa
---

# System banners (enterprise only)

Organization owners can create announcement banners for the organization. Banners
will be displayed to all organization members at the top of every page in the
organization.

You can use Markdown to format your message and link to other documentation
which you may have.

## Steps to creating a banner

- You must be logged in as an Administrator
- Visit the Organization's [settings page]
- Add a message to the **System banners** panel
- Click **Save Banner**

[settings page]: <https://buildkite.com/organizations/~/settings>

## Programmatically creating a system banner

You can create a system banner programmatically via the GraphQL API.

Please review the GraphQL [cookbook] on instructions on how to create
a banner via the API.

[cookbook]: </docs/apis/graphql/cookbooks/organizations#create-a-banner>

0 comments on commit 0987fb9

Please sign in to comment.