Create clearer pathways in docs #9898
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Ooo nice! Yeah, makes a lot of sense! |
pieh
reviewed
Nov 13, 2018
DSchau
approved these changes
Nov 13, 2018
| @@ -4,7 +4,7 @@ title: Gatsby.js Tutorial | |||
|
|
|||
| Welcome to Gatsby! We’re glad you’re here. The goal of this tutorial is to guide you through setting up and deploying your first Gatsby site using a starter template. As we walk through that process, we’ll introduce some more general web development topics, and go over the underlying structure of a Gatsby site. | |||
|
|
|||
| The full tutorial is intended to be as accessible as possible to people without much web development experience (yet!) — no need to be an expert. If you prefer to jump straight to code, feel free to skip the step-by-step tutorial and see the [quick start](/docs/) page. | |||
| > The full tutorial is intended to be as accessible as possible to people without much web development experience (yet!) — no need to be an expert. If you prefer to jump straight to code, feel free to skip the step-by-step tutorial and see the [quick start](/docs/) page. | |||
There was a problem hiding this comment.
👍
We should consider styling blockquotes (with a certain class? all?) like reactjs.org does them. I quite like them!
www/src/pages/docs/index.js
Outdated
| <code>gatsby serve</code> — Gatsby starts a local HTML server | ||
| for testing your built site. | ||
| </li> | ||
| <Link to="/tutorial/">Tutorial</Link>: The tutorial is written to be as accessible as possible to people without much web development experience.</li> |
There was a problem hiding this comment.
These are all quite a bit nicer. Nice work!
m-allanson
added a commit
to kaoDev/gatsby
that referenced
this pull request
Dec 7, 2018
* master: (870 commits) fix(graphql-skip-limit): declare `graphql` peer dependency (gatsbyjs#10305) fix(gatsby-plugin-offline): gracefully degrade if appshell isn't precached (gatsbyjs#10329) Service workers note (gatsbyjs#10276) fix(docs): link fixes, podcast addition (gatsbyjs#10332) feat(docs): Create clearer pathways in docs (gatsbyjs#9898) feat(www): Rename community section to creators (gatsbyjs#10312) docs(graphql-reference): clarify filtering using comma/and operator (gatsbyjs#10321) chore(release): Publish feat(gatsby-plugin-sass): Support Dart SASS (gatsbyjs#10159) fix(gatsby-source-drupal): use basic auth credentials to fetch remote files as well. (gatsbyjs#10302) fix(gatsby-source-filesystem): allow empty password for basic auth in createRemoteFileNode (gatsbyjs#10280) docs(gatsby-remark-prismjs): Use Gatsby V2 project structure (gatsbyjs#10059) chore: update link for react-gatsby-firebase-authentication (gatsbyjs#10314) fix(www): Awesome Gatsby sidebar link (gatsbyjs#10313) Add thijs koerselman to creators list (gatsbyjs#10303) chore(release): Publish fix(gatsby-plugin-emotion): allow for React.Fragment shorthand syntax (gatsbyjs#10291) feat(www): Update starter cards (gatsbyjs#10258) Update index.md (gatsbyjs#10307) Update index.md (gatsbyjs#10306) ...
m-allanson
added a commit
that referenced
this pull request
Dec 8, 2018
* master: (1421 commits) feat(gatsby-image): add onStartLoad prop (#6702) fix(docs): add Ecosystem to docs sidebar, consistency with tutorial sidebar (#10350) fix(www): Starters.yaml housekeeping (#10354) docs: add ttag starter (#10352) docs: document branching (#9983) plugin checker initial commit (#7062) docs: new starter features is required (#10353) docs: migrated line highlighting to highlight-line, highlight-start, highlight-end (#10202) Add Birra Napoli to site showcase (#10344) Add BetterDocs to site showcase (#10349) chore(release): Publish Add option to keep metadata in files processed by `gatsby-plugin-sharp` (#10210) fix(gatsby): [loki] sync db autosaves (#10212) Add Ad Hoc Homework to sites.yml (#10346) fix(graphql-skip-limit): declare `graphql` peer dependency (#10305) fix(gatsby-plugin-offline): gracefully degrade if appshell isn't precached (#10329) Service workers note (#10276) fix(docs): link fixes, podcast addition (#10332) feat(docs): Create clearer pathways in docs (#9898) feat(www): Rename community section to creators (#10312) ...
gpetrioli
pushed a commit
to gpetrioli/gatsby
that referenced
this pull request
Jan 22, 2019
* clarify that VS Code is recommended for consistency throughout the tutorial * some recipe doc consistency * reorg. graphql-reference doesnt make sense in api reference * consistent section title * move quick start from docs landing page to dedicated doc * tweak to tutorial intro * rewrite docs landing page to be a central landing page, and reorg sidebar * style: make the linter happy * style: fix eslint errors in docs/index.js
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
@shannonbux I began making some changes based on our recent interview and resulting conversation.
minor
major
docs vs tutorial
The conversation we had about being unsure where you are (tutorial vs. docs), and not being sure where to start led me down this pathway. It went a bit further than anticipated, but I think it makes a great deal more sense.
Comparison of docs landing page with tutorial landing page:
Compare the above with current org:
GraphQL reference
The GraphQL reference doc was previously indexed under API Reference. It makes more sense in the GraphQL section of the guides. I did some reorganizing along those lines:
(The addition here is "Understanding GraphQL syntax", which links to the reference guide).
ETA: One point on metrics too -- splitting this Docs landing page into these different pathways will give us a better sense of what people are choosing to do, rather than automatically landing on Quick Start guide for docs.