Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add content describing diff between datahub and acryl datahub #10301

Merged

Conversation

shirshanka
Copy link
Contributor

Checklist

  • The PR conforms to DataHub's Contributing Guideline (particularly Commit Message Format)
  • Links to related issues (if applicable)
  • Tests for the changes have been added/updated (if applicable)
  • Docs related to the changes have been added/updated (if applicable). If a new feature has been added a Usage Guide has been added for the same.
  • For any breaking change/potential downtime/deprecation/big changes an entry has been made in Updating DataHub

@github-actions github-actions bot added the docs Issues and Improvements to docs label Apr 16, 2024

## How to read this list

Not a fan of checkboxes? Neither are we.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Totally agree that checkboxes would be bland here, but the current styling is pretty tough to read. At a glance, they look like previously-visited hyperlinks; it's also really hard to see in dark mode:
CleanShot 2024-04-16 at 17 53 43

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, while scrolling down, it's hard to keep the mental model of which color maps to which - by the time I got here, I couldn't easily synthesize which was DataHub vs. Acryl DataHub:
CleanShot 2024-04-16 at 17 53 54

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we work with the Design team to create some static images so we're not limited to markdown formatting?

Copy link
Collaborator

@yoonhyejin yoonhyejin Apr 17, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agree, it's somewhat hard to understand this comparsion intuitively. I don't think it would be too crazy to use markdown table with checkboxes, something like this ; https://datahubproject.io/docs/api/datahub-apis#datahub-api-comparison

If the design is too bland we can do something like the table on a acryl website ; https://www.acryldata.io/
Yet i'm not a big fan of static images becuase the text wouldn't be searchable.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, i think we wouldnt need "How to read this list" if we go with the checkboxes. @shirshanka let me know if you need help with this.

@shirshanka
Copy link
Contributor Author

Addressed review comments. PTAL @yoonhyejin

Copy link
Collaborator

@yoonhyejin yoonhyejin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add some nitpick comments but overall looks great. I hope we can link out more doc contents with this table in the future :)

@shirshanka shirshanka enabled auto-merge (squash) April 17, 2024 06:49
@shirshanka shirshanka disabled auto-merge April 17, 2024 07:47
@shirshanka shirshanka merged commit 36fefaa into datahub-project:master Apr 17, 2024
26 checks passed
sleeperdeep pushed a commit to sleeperdeep/datahub that referenced this pull request Jun 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Issues and Improvements to docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants