How to add a Readme

Have more questions? Submit a request

✍️ What is a Readme?

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 every data asset, using a rich and intuitive editor.

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. This bridges the usual gap that exists between data and its metadata.

πŸ’‘ Spotlight: A Readme provides a space to document the tribal knowledge associated with each data asset, which decreases dependencies on your team members.

πŸ› οΈ A step-by-step guide to adding a Readme

Step 1: Open the data asset page

Click on the name of the asset from the "Assets" 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

Click on the "Add a Readme" option in the Readme section, and the section will open up for editing.


✨ Pro Tip: A well-written Readme is a gift to your future self or any other person using the data!

Step 3: Write your Readme

When you're done documenting everything you know about the data asset, click "Save".

✨ Pro Tip: Use "/" to add images, code blocks, images, and more using the rich text options. This will make your Readme more readable.



All done! Your data Readme is ready to be shared. πŸŽ‰

Pat yourself on the back. It may take time to create, but a Readme is an indispensable feature for documenting any data asset and making it trustworthy. ✌️

Related articles

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