diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2020-03-26 03:07:58 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2020-03-26 03:07:58 +0300 |
commit | 101c30f4dffc624af3cbe3f12edc2cfee570a5f3 (patch) | |
tree | ce7c63b2d73a42ad41d004020410871968974537 /doc/user/admin_area/broadcast_messages.md | |
parent | e1549c75843d235607aebac9ed64f2fd10e549ed (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/user/admin_area/broadcast_messages.md')
-rw-r--r-- | doc/user/admin_area/broadcast_messages.md | 36 |
1 files changed, 34 insertions, 2 deletions
diff --git a/doc/user/admin_area/broadcast_messages.md b/doc/user/admin_area/broadcast_messages.md index 416bd3bfd00..ed03e8a57f3 100644 --- a/doc/user/admin_area/broadcast_messages.md +++ b/doc/user/admin_area/broadcast_messages.md @@ -4,14 +4,46 @@ type: reference, howto # Broadcast Messages **(CORE ONLY)** -GitLab can display messages to all users of a GitLab instance in a banner that appears in the UI. +GitLab can display broadcast messages to all users of a GitLab instance. There are two types of broadcast messages: -![Broadcast Message](img/broadcast_messages.png) +- banners +- notifications + +You can style a message's content using the `a` and `br` HTML tags. The `br` tag inserts a line break. The `a` HTML tag accepts `class` and `style` attributes with the following CSS properties: + +- `color` +- `border` +- `background` +- `padding` +- `margin` +- `text-decoration` + +## Banners + +Banners are shown on the top of a page. + +![Broadcast Message Banner](img/broadcast_messages_banner_v12_10.png) + +## Notifications + +Notifications are shown on the bottom right of a page and can contain placeholders. A placeholder is replaced with an attribute of the active user. Placeholders must be surrounded by curly braces, for example `{{name}}`. +The available placeholders are: + +- `{{email}}` +- `{{name}}` +- `{{user_id}}` +- `{{username}}` +- `{{instance_id}}` + +If the user is not signed in, user related values will be empty. + +![Broadcast Message Notification](img/broadcast_messages_notification_v12_10.png) Broadcast messages can be managed using the [broadcast messages API](../../api/broadcast_messages.md). NOTE: **Note:** If more than one banner message is active at one time, they are displayed in a stack in order of creation. +If more than one notification message is active at one time, only the newest is shown. ## Adding a broadcast message |