diff options
Diffstat (limited to 'doc/user/admin_area/broadcast_messages.md')
| -rw-r--r-- | doc/user/admin_area/broadcast_messages.md | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/doc/user/admin_area/broadcast_messages.md b/doc/user/admin_area/broadcast_messages.md index 0bbdf5bc5e7..c96c57a99eb 100644 --- a/doc/user/admin_area/broadcast_messages.md +++ b/doc/user/admin_area/broadcast_messages.md @@ -1,7 +1,7 @@ --- stage: none group: unassigned -info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments type: reference, howto --- @@ -47,13 +47,13 @@ The available placeholders are: - `{{username}}` - `{{instance_id}}` -If the user is not signed in, user related values will be empty. +If the user is not signed in, user related values are empty.  Broadcast messages can be managed using the [broadcast messages API](../../api/broadcast_messages.md). -NOTE: **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. @@ -70,12 +70,12 @@ To add a broadcast message: 1. Select a date for the message to start and end. 1. Click the **Add broadcast message** button. -NOTE: **Note:** +NOTE: The **Background color** field expects the value to be a hexadecimal code because the form uses the [color_field](https://api.rubyonrails.org/v6.0.3.4/classes/ActionView/Helpers/FormHelper.html#method-i-color_field) helper method, which generates the proper HTML to render. -NOTE: **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. User can also dismiss a broadcast message if the option **Dismissable** is set. @@ -89,7 +89,7 @@ To edit a broadcast message: 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:** +NOTE: Expired messages can be made active again by changing their end date. ## Deleting a broadcast message @@ -103,7 +103,7 @@ To delete a broadcast message: Once deleted, the broadcast message is removed from the list of broadcast messages. -NOTE: **Note:** +NOTE: Broadcast messages can be deleted while active. <!-- ## Troubleshooting |