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

Two types of tutorials, should be unified #4235

Open
pdebruin opened this issue Jun 25, 2024 · 2 comments
Open

Two types of tutorials, should be unified #4235

pdebruin opened this issue Jun 25, 2024 · 2 comments
Assignees

Comments

@pdebruin
Copy link

While working on issues dapr/quickstarts#1028 and #3985, @marcduiker and I ran into the two types of tutorials in docs and in quickstarts, see https://docs.dapr.io/getting-started/tutorials/ This is confusing for the user, since once they enter one type of scenario, they can't easily navigate to the other type.

The tutorials in docs have the advantage of rich mark up with tabs and searchability. The tutorials in quickstarts have the advantage of text close to code.

The proposal part of this issue is open for discussion :-)

Our proposal is to

  • move the tutorial's readme text from quickstarts to docs
  • add a link in the quickstart tutorial readme to the new tutorial location in docs
  • refactor the tutorial in their new location to make sure links work and to leverage docs capabilities like tabs
@hhunter-ms
Copy link
Collaborator

@pdebruin I can work on something like this, after 1.14 release. to clarify, essentially you'd like to bring the quickstarts/tutorials readme instructions into the Tutorials section of the docs? Instead of just linking off to them like we do now?

@hhunter-ms hhunter-ms self-assigned this Jul 30, 2024
@pdebruin
Copy link
Author

I do, but I would like to hear @paulyuk 's opinion too as quickstarts maintainer

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

No branches or pull requests

2 participants