How to create README templates

πŸ€“ Who can do this? You will need to be an admin user in Atlan to create and manage README templates.

Admin users in Atlan can create, curate, and manage README templates from the governance center. Once admin users have created the templates, other users will be able to select these templates and enrich their assets with READMEs. They will also be able to see a rich preview of each template before adding the relevant documentation.

Create a README template


To create a README template:

  1. In the left menu in Atlan, click Governance.
  2. Under the Governance heading, click Readme templates.
  3. On the Readme templates page, click Get started.
  4. In the Untitled Template dialog box, enter the following details:
    1. For template name, enter a name for your template.
    2. (Optional) For Add description, add a description for your template.
    3. (Optional) To add an icon, click on the image icon.
  5. Click Create to proceed. 
  6. In the text editor, add your template.
  7. Click Save.
  8. (Optional) To edit the template, in the upper right of the screen, click the pencil icon. 

Your README template is now available in the templates manager! πŸŽ‰

Related articles

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