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

fix(docs): fixes link to developers guides #8809

Merged
merged 7 commits into from
Sep 22, 2023

Conversation

sgomezvillamor
Copy link
Contributor

@sgomezvillamor sgomezvillamor commented Sep 8, 2023

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

  • 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

@sgomezvillamor sgomezvillamor marked this pull request as ready for review September 8, 2023 08:03
@sgomezvillamor sgomezvillamor changed the title fix(docs): fixes link to developers guide fix(docs): fixes link to developers guides Sep 8, 2023
@sgomezvillamor
Copy link
Contributor Author

ICYMI @maggiehays This may not be an error but a feature, however current redirection always confused me, so trying to fix here 😅

Copy link
Collaborator

@jjoyce0510 jjoyce0510 left a 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!

@yoonhyejin
Copy link
Collaborator

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.

@sgomezvillamor
Copy link
Contributor Author

sgomezvillamor commented Sep 21, 2023

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.

Captura de Pantalla 2023-09-21 a las 7 02 52

Alternatively "Developer Guides" may be renamed to "Contributor Guides"

  {
    title: "Contributor Guides",
    icon: <CodeTwoTone />,
    description: "Developing on DataHub",
    to: "/docs/developers",
  },

or just removing the box at all

@hsheth2 hsheth2 merged commit 930ad2c into datahub-project:master Sep 22, 2023
39 checks passed
@sgomezvillamor sgomezvillamor deleted the patch-1 branch September 26, 2023 08:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants