apache / apache/druid

Tutorial order for the docs

Open
#13,646 0 comments 0 reactions 0 assignees View on GitHub
Area - Documentation
Dominant language
Java
Stars
14.1k
Forks
3.8k
Avg merge
2d 58m
Merged PRs (30d)
233

Description

Currently, there’s no sequencing or even a basic order for the tutorials that a new user can follow. The only tidbit that tells users what to do next are in the Next steps sections, specifically the one at the bottom of the [Quickstart (local)](https://druid.apache.org/docs/latest/tutorials/index.html#next-steps) page.

There should be an index page that lays out a suggested tutorial sequence for a new user to follow so that they learn about Druid in a logical progression.

Once this sequence is laid out, the left nav for tutorials should also be updated to reflect the order.

Contributor guide

Open the contributing guide

Research direction

Start with the Tutorials index and the Quickstart (local) page, especially its Next steps section, then review the existing tutorial list and left navigation. Define a logical progression for new users, add an index page describing that sequence, and update the tutorial navigation to match it.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.