mirror of
https://github.com/datahub-project/datahub.git
synced 2025-07-18 23:02:11 +00:00
4956f5a165
* update sidebar titles to remove About DataHub * move impact analysis guide to new folder; update links * update copy in Understand Data in Context section * adding feature guide template to sidebar * adding feature guide template * update docs readme to link to feature guide template * enhance docs-website readme * add comments to feature guide template * add links to graphql and lineage resources * linter cleanup * updating reference links * update to graphql reference links * add image and gif best practices * update feature guide template with image details * fix link * update template from YouTube -> Videos * Update docs-website/README.md Co-authored-by: Harshal Sheth <hsheth2@gmail.com> * update feature to Lineage Impact Analysis Co-authored-by: Harshal Sheth <hsheth2@gmail.com>
83 lines
2.2 KiB
Markdown
83 lines
2.2 KiB
Markdown
import FeatureAvailability from '@site/src/components/FeatureAvailability';
|
|
|
|
# About DataHub [Feature Name]
|
|
|
|
<!-- All Feature Guides should begin with `About DataHub ` to improve SEO -->
|
|
|
|
<!--
|
|
Update feature availability; by default, feature availabilty is Self-Hosted and Managed DataHub
|
|
|
|
Add in `saasOnly` for Managed DataHub-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
|
|
|
|
-->
|
|
|
|
*Need more help? Join the conversation in [Slack](http://slack.datahubproject.io)!*
|
|
|
|
### Related Features
|
|
|
|
<!-- Bulleted list of related features; comment out section if none --> |