Skip to content

Commit

Permalink
docs: add ui banner options in docs (argoproj#10907)
Browse files Browse the repository at this point in the history
Signed-off-by: saumeya <[email protected]>

Signed-off-by: saumeya <[email protected]>
  • Loading branch information
saumeya authored Nov 3, 2022
1 parent 327936d commit 3047db9
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion docs/operator-manual/custom-styles.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ experience, you may wish to build a separate project using the [Argo CD UI dev s

## Banners

Argo CD can optionally display a banner that can be used to notify your users of upcoming maintenance and operational changes. This feature can be enabled by specifying the banner message using the `ui.bannercontent` field in the `argocd-cm` ConfigMap and Argo CD will display this message at the top of every UI page. You can optionally add a link to this message by setting `ui.bannerurl`.
Argo CD can optionally display a banner that can be used to notify your users of upcoming maintenance and operational changes. This feature can be enabled by specifying the banner message using the `ui.bannercontent` field in the `argocd-cm` ConfigMap and Argo CD will display this message at the top of every UI page. You can optionally add a link to this message by setting `ui.bannerurl`. You can also make the banner sticky (permanent) by setting `ui.bannerpermanent` to `true` and change it's position to the bottom by using `ui.bannerposition: "bottom"`
### argocd-cm
```yaml
Expand All @@ -113,6 +113,8 @@ metadata:
data:
ui.bannercontent: "Banner message linked to a URL"
ui.bannerurl: "www.bannerlink.com"
ui.bannerpermanent: "true"
ui.bannerposition: "bottom"
```
![banner with link](../assets/banner.png)

0 comments on commit 3047db9

Please sign in to comment.