Skip to content

Commit 36aa4c9

Browse files
author
Néstor Diaz
authored
Add announcement banner doc in README.md (#624)
1 parent 68d603e commit 36aa4c9

1 file changed

Lines changed: 11 additions & 0 deletions

File tree

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,3 +68,14 @@ Run the next script to execute unit tests:
6868
```
6969
npm run test
7070
```
71+
72+
## Show general announcement
73+
There is a handy feature to show general messages in the submission tool. If something needs to be announce to all the users a new `Announcement banner` is available in the app. The title, priority and description of the title are provided through environment variables.
74+
75+
To show the general announcement set the variables below in GitLab with the desired values. Please make sure you select an environment while setting the env vars otherwise the announcement will be visible in all environments. The priority value can be any of the [available types](https://getbootstrap.com/docs/5.1/components/alerts/#examples) for the Bootstrap Alert component.
76+
77+
```js
78+
APP_ANNOUNCEMENT_HEADLINE=Announcement title
79+
APP_ANNOUNCEMENT_CONTENT=Announcement body
80+
APP_ANNOUNCEMENT_PRIORITY=priority
81+
```

0 commit comments

Comments
 (0)