manifoldco / manifoldco/torus-cli

Update the Quickstart guide

Open
#304 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

good first issue help wanted
Dominant language
Go
Stars
603
Forks
30
PR merge metrics
No merged PRs in 30d

Description

Starting at the "Create a staging environment", the steps described in the guide quickly outpace the explanations and it was not obvious to me what was going on. The quickstart assumes knowledge of concepts (environments, machines) that I would have liked to see brief explanations of.

The Quickstart could also use now.sh as an example deployment environment so that the user can follow along with the guide themselves. I could follow along almost exactly with the first half of the guide, but after "Take secrets beyond development" I couldn't follow along myself.

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.

Research direction

Start with the Quickstart guide at “Create a staging environment” and read through “Take secrets beyond development” to identify where explanations are missing. Add brief context for environments and machines, include now.sh as a deployment example, and verify that readers can follow the guide through the later steps.

Written by the indexing model from the issue text.

Assessment

Domain
cli, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.