-
Notifications
You must be signed in to change notification settings - Fork 2.9k
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
fix(docs): fixes link to developers guides #8809
Conversation
ICYMI @maggiehays This may not be an error but a feature, however current redirection always confused me, so trying to fix here 😅 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would actually prefer this to link to "https://datahubproject.io/docs/api/datahub-apis"
which is the base for all the API + CLI docs for datahub.
My understanding is that our developer facing docs are primarily about using datahub as opposed to really developing on datahub core :) -- so should be more API focused.
I'll let @yoonhyejin add any thoughts!
Thanks @sgomezvillamor for raising this! I def agree that the redirection to /cli is a bit confusing. Also agree with @jjoyce0510 - I think the use case here is more on the API/SDKs side. |
Thanks for the review @jjoyce0510 and @yoonhyejin . I did apply you suggestion in 165c592 and once deployed https://docs-website-lmqydzp5o-acryldata.vercel.app/docs/ I realized that there is already a "box" for API, so such a redirect in "Developer Guides" is redundant. Alternatively "Developer Guides" may be renamed to "Contributor Guides"
or just removing the box at all |
This is the redirection I expect when I click on "developer guides".
Being redirected to "DataHub CLI" always confused me
So proposing this change
Checklist