Welcome to mirror list, hosted at ThFree Co, Russian Federation.

gitlab.com/gitlab-org/gitlab-foss.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEvan Read <eread@gitlab.com>2019-01-24 19:48:37 +0300
committerMarcia Ramos <marcia@gitlab.com>2019-01-24 19:48:37 +0300
commit01f8f7962450d63b801ca0322a7f652f7fdf76b0 (patch)
tree03f01d42eafeb049acecb35c30865e21b5db9594 /doc/user/admin_area/broadcast_messages.md
parent6e085eea531f77b341d9635f6e4dd2ba535a371f (diff)
Document broadcast messages in UI
Diffstat (limited to 'doc/user/admin_area/broadcast_messages.md')
-rw-r--r--doc/user/admin_area/broadcast_messages.md51
1 files changed, 51 insertions, 0 deletions
diff --git a/doc/user/admin_area/broadcast_messages.md b/doc/user/admin_area/broadcast_messages.md
new file mode 100644
index 00000000000..51949088521
--- /dev/null
+++ b/doc/user/admin_area/broadcast_messages.md
@@ -0,0 +1,51 @@
+# Broadcast Messages
+
+GitLab can display messages to all users of a GitLab instance in a banner that appears in the UI.
+
+![Broadcast Message](img/broadcast_messages.png)
+
+NOTE: **Note:**
+If more than one banner message is active at one time, they are displayed in a stack in order of creation.
+
+## Adding a broadcast message
+
+To display messages to users on your GitLab instance, add broadcast message.
+
+To add a broadcast message:
+
+1. Navigate to the **Admin Area > Messages** page.
+1. Add the text for the message to the **Message** field. Markdown and emoji are supported.
+1. If required, click the **Customize colors** link to edit the background color and font color of the message.
+1. Select a date for the message to start and end.
+1. Click the **Add broadcast message** button.
+
+NOTE: **Note:**
+Once a broadcast message has expired, it is no longer displayed in the UI but is still listed in the
+list of broadcast messages.
+
+## Editing a broadcast message
+
+If changes are required to a broadcast message, they can be edited.
+
+To edit a broadcast message:
+
+1. Navigate to the **Admin Area > Messages** page.
+1. From the list of broadcast messages, click the appropriate button to edit the message.
+1. After making the required changes, click the **Update broadcast message** button.
+
+TIP: **Tip:**
+Expired messages can be made active again by changing their end date.
+
+## Deleting a broadcast message
+
+Broadcast messages that are no longer required can be deleted.
+
+To delete a broadcast message:
+
+1. Navigate to the **Admin Area > Messages** page.
+1. From the list of broadcast messages, click the appropriate button to delete the message.
+
+Once deleted, the broadcast message is removed from the list of broadcast messages.
+
+NOTE: **Note:**
+Broadcast messages can be deleted while active.