Back to Datahub

[Feature Name]

docs/_feature-guide-template.md

1.5.0.32.1 KB
Original Source

import FeatureAvailability from '@site/src/components/FeatureAvailability';

[Feature Name]

<!-- All Feature Guides should begin with `About DataHub ` to improve SEO --> <!-- Update feature availability; by default, feature availabilty is Self-Hosted and DataHub Cloud Add in `saasOnly` for DataHub Cloud-only features --> <FeatureAvailability/> <!-- This section should provide a plain-language overview of feature. Consider the following: * What does this feature do? Why is it useful? * What are the typical use cases? * Who are the typical users? * In which DataHub Version did this become available? -->

[Feature Name] Setup, Prerequisites, and Permissions

<!-- This section should provide plain-language instructions on how to configure the feature: * What special configuration is required, if any? * How can you confirm you configured it correctly? What is the expected behavior? * What access levels/permissions are required within DataHub? -->

Using [Feature Name]

<!-- Plain-language instructions of how to use the feature Provide a step-by-step guide to use feature, including relevant screenshots and/or GIFs * Where/how do you access it? * What best practices exist? * What are common code snippets? -->

Additional Resources

<!-- Comment out any irrelevant or empty sections -->

Videos

<!-- Use the following format to embed YouTube videos: **Title of YouTube video in bold text** <p align="center"> <iframe width="560" height="315" src="www.youtube.com/embed/VIDEO_ID" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe> </p> --> <!-- NOTE: Find the iframe details in YouTube by going to Share > Embed -->

GraphQL

<!-- Bulleted list of relevant GraphQL docs; comment out section if none -->

DataHub Blog

<!-- Bulleted list of relevant DataHub Blog posts; comment out section if none -->

FAQ and Troubleshooting

<!-- Use the following format: **Question in bold text** Response in plain text --> <!-- Bulleted list of related features; comment out section if none -->