README

Add a description right next to your data assets

โœ๏ธ What is a README?

"Readme is the first file every user will look for, whenever they are checking out the code repository." -Algorithmia

A README is an essential part of every code repository. The better the README, the more collaborators will want to work on your code.

The same holds true for data! Each data asset should have its own README, where you can describe its characteristics and other critical information.

Atlan lets users add a README ๐Ÿ“ for each and every data asset. The best part is that the README appears right below each data table, putting the data and its context all together on the same screen.

Atlan not only provides a rich editor to write the README, but by placing it right next to the data, Atlan bridges the usual gap that exists between the data and its metadata.

โœจ Spotlight: A README provides a space to document the tribal knowledge associated with each data asset, thus removing human dependencies.

๐Ÿ› ๏ธ A step-by-step guide to add a README

STEP 1: Open the dedicated data asset page

Click on the name of the asset from the 'Discover' tab to open the dedicated page.

๐Ÿ‘€ Note: A README can be added to all different types of data assets inside Atlan, like BI dashboards, widgets, columns, databases and schemas.

STEP 2: Open the README for editing

Click on the 'Edit' โœ๏ธ option in the README section, and all the editing options will show up at the top.

๐Ÿง™โ€โ™€๏ธ Remember: A well-written data README is a gift to your future self or any other person using the data!

STEP 3: Write your README and click ๐Ÿ’พ 'Save'

๐ŸŒŸ Pro Tip: You can add images, tables, GIFs, etc using the rich text editor. This will make your README more readable.

And done ๐ŸŽ‰ Your data README is ready to be consumed.

README and data preview

A README is an indispensable feature to understand any data asset in its entirety and make it trustworthy โœŒ๏ธ