Hey folks! First off, the Grab team would like to ...
# design-datahub-documentation
b
Hey folks! First off, the Grab team would like to thank DataHub for sending out the Polly poll to better understand the community’s usage on the documentation feature. And also thanks to everyone who joined this channel to share their thoughts! With that, I’d like to provide a summary of what we’ve been working on so far and to share some updates. Also added some screenshots too! We’re building this within our own fork of DataHub so stylings will differ slightly. • We’ll not be dropping Markdown support. Markdown is here to stay and will continue to be format for storing these documentation. • New features provided ◦ @-mentions - users will be able to tag their entities in their documentation. These tags will be stored in as
[@<entity_name>](<entity_urn>)
in Markdown (e.g.
[@SampleHdfsDataset](urn:li:dataset:(urn:li:dataPlatform:hdfs,SampleHdfsDataset,PROD))
). If you’re using other Markdown editors, these should most likely appear as the tagged name only like:
@SampleHdfsDataset
. • UX improvements ◦ WYSIWYG Editor - users will no longer be required to write in Markdown but Markdown shortcuts will still be supported ◦ Tables would show more user-friendly controls to add/remove rows and columns ◦ Users can add images and links using a proper modal with a form instead For existing documentations that are using GitHub Flavoured Markdown (GFM), rest assured that the new editor will still be able to render your content. If you have any suggestions, please feel free to let us know too!
thank you 1
😍 1
teamwork 6
🚀 6
@bulky-soccer-26729 @little-megabyte-1074 thanks for the joining the regular sync ups the past few sessions. The sessions have been extremely helpful! The Grab team is now focusing on implementation so we’re suggesting to stop the recurring sync and have ad-hoc calls when needed. Any thoughts? fyi: @boundless-student-48844
l
Hey @brave-insurance-80044!! Thanks SO MUCH for this amazing summary - I’m totally on board with removing the recurring meetings & moving to ad hoc as needed. I’ll go ahead and cancel the routine and keep us posted on how we can help!
b
The table controls are awesome!
One thing we've been considering is how to enable rich embedding of content from the UI. I think we'd need a file-upload API but it's totally doable
b
@big-carpet-38439 For file upload API, any thought on what could be used as the file storage? We’ve been thinking of using S3 but am thinking how we could make it generic so it could be port back to the open-source