ui-notifications
This displays maintenance and release notes on the Instana UI via a GitHub Pages project site.
Maintenance Note
You can show users a maintenance note by adding a note the the content/maintenance.md file. You can use markdown in the file to format the note’s content. We recommend that you keep formatting restricted to emphasizes of certain words and times for a consistent look and feel. The following shows the content of the content/maintenance.md could be and what the UI would render.
There will be a maintenance for your environment from *10:00 UTC on*.
To remove the maintenance message, empty the content/maintenance.md file.
Release Notes
Release notes for a specific release number will be shown to users via the respective file identified by its release number in content/release-notes/. Also ensure that you add a new entry for your new file in content/release-notes/index.json.
You can use markdown in this file and there is no document size restriction. If you want to use links in the release notes file, you can do so. Just make sure that you use absolute links instead of relative ones. For instance, in order to reference a file pic.png which is located in the content/files/ directory, use the link /notifications/files/pic.png.
Contributing
When adding a maintenance note or release notes to this repository, ensure that:
- A deployment to GitHub Pages is triggered successfully here
- There are no markdown errors (if you’re using markdown) by viewing your file in GitHub
- Your file is visible via its GitHub Pages URL. Example: http://instana.github.io/ui-notifications/content/release-notes/1.149.md