Improve next steps onboarding experience

Open
#352 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
30/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Stale
Tech stack
python
Domain
cli, documentation

Research direction

Review the existing taskgraph init flow, the two hello-world tutorials, and the current how-to and reference material first. Agree on a concrete next-step onboarding scope; the work is done when the chosen tutorial or initialization path guides users beyond hello world into a useful task workflow.

Written by the indexing model from the issue text.

Description

We have decent documentation and tools to get set up with a working graph. There's taskgraph init and two tutorials that walk you through getting a hello world task running. We also have a decent amount of how-to guides and reference material.

But we're missing some stuff in-between. I had a conversation where someone was able to get a working hello world task, but was then lost about what to do next. I think we have a lot of room for improvement here. Some ideas:

  1. A tutorial that walks through setting up an actually useful task (perhaps a lint, or a build)
  2. Expand taskgraph init a bit to mimic real world usage a little more. Maybe a build, a test and a lint task.
  3. ??? Ideas welcome
Dominant language
Python
Stars
26
Forks
55
Avg merge
2d 6m
Merged PRs (30d)
15

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from taskcluster/taskgraph

All issues in taskcluster/taskgraph

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.