Hi folks!
Here’s some additional context about why we created this channel. @big-carpet-38439 and I met with @brave-insurance-80044 (Grab) & @boundless-student-48844 (Grab) yesterday to discuss some proposed improvements to DataHub’s documentation functionality. Separately, we’ve been having conversations with folks from GResearch to see if there are ways we can collaborate on improvements to the UI; hoping this is a great first initiative!
Here’s my understanding of the scope of this design/discovery work:
Use Cases/User Studies
• Provide more robust documentation functionality within DataHub to help end-users capture & share institutional knowledge
◦ In scope: All entity-level descriptions, column descriptions?
• Support tagging/associating DataHub entities and DataHub Users within the documentation itself (similar to GSuite or other Wiki functionality to support inline lookup/linking)
• Support version control for changes made to documentation; easily view who made which change; toggle between historical versions
• Upload files/images into documentation
• Move away from markdown-first editors to remove friction for users not well-versed in .md formatting
Out of Scope for now:
• Creating a new documentation-specific entity type within DataHub; we want to see how much of an impact we can have without further complicating the underlying entity model (Glossary Terms, Domains, etc.)
Discovery/Decisions to be made:
• What is the most stable editor for us to implement? — Please see @brave-insurance-80044 doc above!!
• If we change editors, what is the impact on existing markdown docs? What is the migration strategy?
• If we support @-mentions, what is the notification story within OSS DataHub?
• If we support file/image upload, will this require net-new file storage functionality within DatHub?
• What is the user experience if documentation is pushed programmatically during ingestion? Does it replace UI-generated documentation?