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

SDK Packages links navigate away from SDK content into conceptual/HTTP content #1550

Closed
paulyuk opened this issue Jun 11, 2021 · 1 comment · Fixed by #3610
Closed

SDK Packages links navigate away from SDK content into conceptual/HTTP content #1550

paulyuk opened this issue Jun 11, 2021 · 1 comment · Fixed by #3610
Assignees
Labels
area/sdks content/incorrect-information Content in the docs is incorrect P2

Comments

@paulyuk
Copy link
Contributor

paulyuk commented Jun 11, 2021

Describe the issue
Starting from the SDKs doc page, all the top prominent links discuss scenarios that can be done in Client SDKs, Server extensions, and Actor SDKs, but each link actually navigates AWAY from the right SDK topic and instead shows the generic HTTP.

URL of the docs
https://docs.dapr.io/developing-applications/sdks/
Try Invoke, state, Actor-invoked, etc

Expected content
These links should take you to an SDK how to for that scenario, with a language pivot. For example I should click Invoke, then go to a how to for invoke using SDKs, with tabs or some other navigation for language.

Screenshots
Starting at SDK page click any link above the fold like Invoke
image

We're taken to this general overview and http only content, and lost context of SDKs.
https://docs.dapr.io/developing-applications/building-blocks/service-invocation/
image

But I'd want to see docs like this:
https://docs.dapr.io/developing-applications/sdks/python/python-client/#invoke-a-service
image

Additional context

@paulyuk paulyuk added P1 content/incorrect-information Content in the docs is incorrect labels Jun 11, 2021
@AaronCrawfis AaronCrawfis added P2 and removed P1 labels Jun 14, 2021
@AaronCrawfis
Copy link
Collaborator

Breaking this into smaller items:

  • Adding tab items for SDK clients in all how-to guides within the building blocks section
  • Update SDK overview doc to better route users

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/sdks content/incorrect-information Content in the docs is incorrect P2
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants