dapr / dapr/docs

Two types of tutorials, should be unified

Open
#4,235 2 comments 0 reactions 1 assignee Claimed by @hhunter-ms View on GitHub
Dominant language
SCSS
Stars
1k
Forks
794
Avg merge
2d 8h
Merged PRs (30d)
7

Description

While working on issues https://github.com/dapr/quickstarts/issues/1028 and https://github.com/dapr/docs/issues/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

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.