From f0a71f4d36a254f245c8b8f3ae9ae599be40f7af Mon Sep 17 00:00:00 2001 From: James Hill Date: Tue, 19 Sep 2023 23:07:30 +1000 Subject: [PATCH] Create System Banners Documentation Document the new system banners enterprise only feature for organizations to communicate with their staff via announcement banners --- data/nav.yml | 2 ++ pages/team_management.md | 1 + pages/team_management/system_banners.md | 30 +++++++++++++++++++++++++ 3 files changed, 33 insertions(+) create mode 100644 pages/team_management/system_banners.md diff --git a/data/nav.yml b/data/nav.yml index b9a4037608..eedce79115 100644 --- a/data/nav.yml +++ b/data/nav.yml @@ -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" diff --git a/pages/team_management.md b/pages/team_management.md index b05209cbbd..aba326a4fc 100644 --- a/pages/team_management.md +++ b/pages/team_management.md @@ -7,4 +7,5 @@ toc: false 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: - [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) diff --git a/pages/team_management/system_banners.md b/pages/team_management/system_banners.md new file mode 100644 index 0000000000..e5eb1e22a3 --- /dev/null +++ b/pages/team_management/system_banners.md @@ -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 +- Vist the Organization's [settings page] +- Add a message to the **System banners** panel +- Click **Save Banner** + +[settings page]: + +## 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]: