Skip to content

Commit 3d2f82d

Browse files
Fix linting
1 parent be34359 commit 3d2f82d

File tree

1 file changed

+4
-0
lines changed
  • docs/blog/2019-05-22-cli-error-redesign

1 file changed

+4
-0
lines changed

docs/blog/2019-05-22-cli-error-redesign/index.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,15 @@ tags:
99
---
1010

1111
## How did this project come about?
12+
1213
The CLI is the main entry point and interface people have (currently) for Gatsby. Everyone sees it! So it has a huge influence on people’s experience of Gatsby.
1314

1415
We conducted 4 usability tests with awesome Gatsby users to learn how they do tasks using the Gatsby CLI and how they use error messages to debug their projects. Thanks [Simon Koelewijn](https://github.com/smnk), [Gene Smith](https://twitter.com/gene_r_smith), [Jonathan Prozzi](https://github.com/jonathanprozzi), and [Benjamin Lannon](https://github.com/lannonbr) for teaching us how you use the CLI, and thanks to [@sidharthachatterjee](https://github.com/sidharthachatterjee), [@wardpeet](https://github.com/wardpeet), [@pieh](https://github.com/pieh), [@m-allanson](https://github.com/m-allanson), [@gillkyle](https://github.com/gillkyle) for copiloting the interviews with me and helping turn what we learned into action.
1516

1617
If you want to be part of future usability tests, [sign up here](https://mailchi.mp/84f6243ba763/gatsby-usability-newsletter-signup).
1718

1819
## What did we learn?
20+
1921
Our error messages aren't always helpful; sometimes they are even absent! They don't comply with best practices suggested by the research we did.
2022

2123
We did a thorough search of other CLIs and style guides to learn what we're doing well and where we might be falling short. Here are resources that informed our knowledge of problems that Gatsby CLI has and possible ways to solve those problems:
@@ -28,6 +30,7 @@ We did a thorough search of other CLIs and style guides to learn what we're doin
2830
- [User journey through the Gatsby CLI](https://whimsical.co/2PxMcRGE63bwk1Ayc3emAB) (informed by usability interviews and the Gatsby core team’s observations of what issues are most common regarding the CLI)
2931

3032
## What do we need to do next?
33+
3134
To optimize the CLI design, we’ll use the data being collected through our telemetry setup, which collects data about CLI usage (opt out is possible).
3235

3336
1. Crunch some numbers to find out what the most common error messages are that people get
@@ -36,6 +39,7 @@ To optimize the CLI design, we’ll use the data being collected through our tel
3639
4. Do some other things that will make the CLI easier to use (easier = takes less time to do a task and/or is less frustrating). See [issues tagged with `topic: cli`](https://github.com/gatsbyjs/gatsby/issues?q=is%3Aopen+is%3Aissue+label%3A%22topic%3A+cli%22) in the OSS repo!
3740

3841
## Want to dive in and help / comment?
42+
3943
The first step is to get consensus on the [Error Survey RFC](https://github.com/gatsbyjs/rfcs/pull/37) & [CLI Redesign RFCs](https://github.com/gatsbyjs/rfcs/pull/38) and start on the changes they suggest.
4044

4145
All issues related to those RFCs will be [tagged with `topic: cli`](https://github.com/gatsbyjs/gatsby/issues?q=is%3Aopen+is%3Aissue+label%3A%22topic%3A+cli%22) in the OSS repo.

0 commit comments

Comments
 (0)