How to create announcements

Adding an announcement to your data asset helps you call attention to an important feature or notify others about a change coming down the pipeline. Since announcements in Atlan display the time stamp and author information, you can easily identify whether an announcement is still relevant and who to ask for questions.

What type of announcements would you want to share with your team? Here are a few examples:

Screenshot 2023-10-30 at 10.42.11 AM.pngScreenshot 2023-10-30 at 10.43.24 AM.pngScreenshot 2023-10-30 at 10.44.31 AM.png

Add an announcements

 

To add an announcement to an asset:

  1. From the left menu of any screen in Atlan, click Assets.
  2. On the Assets page, select an asset to add an announcement. You can either:
    • Open the asset profile. From the top right of the Overview tab in the asset profile, click the vertical 3-dot icon, and then from the dropdown, click Add announcement.
    • In the Overview tab of the asset sidebar, click the horizontal 3-dot icon, and then from the dropdown, click Add announcement.
  3. In the New Announcement dialog, enter the following details:
    1. From the top right, click the downward arrow and choose from three announcement types: Information, Issue, or Warning.
    2. For Add title, enter a title for your announcement.
    3. For Description, enter a description for your announcement.
      • (Optional) You can include HTML hyperlinks to direct users to additional information — for example, wrap the text with <a href="https://my.url.com">description text</a>.
      • (Optional) You can use Markdown syntax to write a description. Any headings will be rendered in heading 6 (<h6>).
      🚨 Careful! Atlan currently does not support adding images to your announcements.
    4. (Optional) To share your announcement on Slack or Teams, you can either:
    5. (Optional) To configure the announcements channel for Slack or Teams:
      • If you have already configured a Slack or Microsoft Teams channel to receive announcement alerts, that channel will be preselected. You can change to a different channel, if available.
      • If you have not configured a channel for announcements, enter the channel name to receive notifications for announcements. This channel will be displayed as the Announcements channel in your Slack or Microsoft Teams integration.
    6. Click Add to create your announcement.
  4. (Optional) To edit an announcement, from the top right of the announcement box, click the 3-dot icon and then click Edit.
  5. (Optional) To delete an announcement, from the top right of the announcement box, click the 3-dot icon and then click Delete.

You just created an announcement! 🎉

This announcement will be visible to anyone who views the asset. You can also create similar announcements for other types of data assets, including glossaries, categories, and terms.

To create, remove, and manage announcements using API, refer to our developer documentation.

💪 Did you know? You can only create one announcement per asset. To add more information to your announcement, you can either edit the existing one to update it or delete the old one and create a new announcement.

Related articles

Was this article helpful?
1 out of 1 found this helpful