Alerts

This extension provides simple, customizable, and responsive notifications for your Help Center.

InstallationUsage

1. Unpack the downloaded zip file. Extract the contents of the zip file, which includes the following files:

   • lotus-alerts.js
   • Readme.md

2. In Guide, click on the Customize design icon in the sidebar. The Theming Center page will be opened.

3. Click the theme you want to modify.

4. Click the Edit code button.

5. Add the extension assets. In theAssets section, click Add asset. Browse to the location of your unzipped file and select lotus-alerts.js.

   The file will now appear in your list of assets.

6. Insert the script. In the theme code editor, locate and open the document_head.hbs file under the templates directory.

7. Paste the following snippet to the document_head.hbs:

   <script src="{{asset 'lotus-alerts.js'}}"></script>

8. Publish your changes. Once you’re done, click Publish to update your theme.

1. Create a new article for the alert. It will be used for the content of an alert.

2. (Guide Enterprise only) If you are on Guide Enterprise, click Article settings. This step is not necessary for Guide Professional.

3. In Labels in the right sidebar, start typing the label you want to add, then select Add as new label or select the matching label if it exists. Article labels are not case-sensitive.

   There are four types of alert labels:

   • alert_danger

     

   • alert_info

     

   • alert_success

     

   • alert_warning

     
4. Make sure that you have the correct article visibility settings in the Visible to field.
5. Save the changes.

Please note that after adding a label and publishing the article, it may take up to 5 minutes before the banner appears. It's because Zendesk doesn't reflect changes immediately in the API.