docs(authentication-tutorial): use hello-world stater instead of default #10690

pieh · 2018-12-27T20:07:13Z

This changes starter used in authentication tutorial to hello-world.

Reasons:

default starter changes quite often (especially lately), so tutorial parts referencing code of the starter are getting outdated and confusing or would require often manual sync to reflect latest state of the default starter code
default starter has parts that are not focus point of this tutorial and generate unneeded distractions (react-helmet, StaticQuery, siteMetadata)

Ref comments in #10674

---edit:
look of the site after completing tutorial:

tutorial page preview (lame in image - just to more easily verify highlighting if someone want to):

KyleAMathews · 2018-12-27T20:21:40Z

Nice!

docs/docs/authentication-tutorial.md

francesmx

Looks good to me 🚀

calcsam · 2019-01-25T15:35:59Z

Since Dustin reviewed this, going to merge 👍

## Description I've seen some tweets that indicate that _sometimes_ there can be confusion as to whether to use uppercase or lowercase conventions for React component file names. This isn't specific to Gatsby, but we can resolve some of this by documenting a consistent format, and for that I'd recommend that we consistently document lowercase with a dash separating terms (dasherized, e.g. NavBar is `nav-bar.js`). This is what we use in the starters (e.g. src/components/header.js instead of src/components/Header.js) outside of the blog starter--which has been normalized in this PR. I've also done a simple find and replace for usage of these (e.g. src/components/Bio.js -> src/components/bio.js) so that the documentation matches the usage. There are additional uppercase components (e.g. src/components/SEO.js) but I left those as is, since the usage of them where referenced is also uppercase. ## Related Issues Sorta related to #10671 as well as my comment [here](#10690 (comment))

## Description I've seen some tweets that indicate that _sometimes_ there can be confusion as to whether to use uppercase or lowercase conventions for React component file names. This isn't specific to Gatsby, but we can resolve some of this by documenting a consistent format, and for that I'd recommend that we consistently document lowercase with a dash separating terms (dasherized, e.g. NavBar is `nav-bar.js`). This is what we use in the starters (e.g. src/components/header.js instead of src/components/Header.js) outside of the blog starter--which has been normalized in this PR. I've also done a simple find and replace for usage of these (e.g. src/components/Bio.js -> src/components/bio.js) so that the documentation matches the usage. There are additional uppercase components (e.g. src/components/SEO.js) but I left those as is, since the usage of them where referenced is also uppercase. ## Related Issues Sorta related to gatsbyjs/gatsby#10671 as well as my comment [here](gatsbyjs/gatsby#10690 (comment))

…ult (#10690) * docs(authentication-tutorial): use hello-world stater instead of default * navBar -> nav-bar

## Description I've seen some tweets that indicate that _sometimes_ there can be confusion as to whether to use uppercase or lowercase conventions for React component file names. This isn't specific to Gatsby, but we can resolve some of this by documenting a consistent format, and for that I'd recommend that we consistently document lowercase with a dash separating terms (dasherized, e.g. NavBar is `nav-bar.js`). This is what we use in the starters (e.g. src/components/header.js instead of src/components/Header.js) outside of the blog starter--which has been normalized in this PR. I've also done a simple find and replace for usage of these (e.g. src/components/Bio.js -> src/components/bio.js) so that the documentation matches the usage. There are additional uppercase components (e.g. src/components/SEO.js) but I left those as is, since the usage of them where referenced is also uppercase. ## Related Issues Sorta related to gatsbyjs/gatsby#10671 as well as my comment [here](gatsbyjs/gatsby#10690 (comment))

docs(authentication-tutorial): use hello-world stater instead of default

12c359e

pieh requested a review from a team December 27, 2018 20:07

DSchau reviewed Dec 27, 2018

View reviewed changes

docs/docs/authentication-tutorial.md Outdated Show resolved Hide resolved

DSchau mentioned this pull request Dec 27, 2018

chore: standardize on lowercase/dasherized file names #10691

Merged

navBar -> nav-bar

260c1b4

francesmx approved these changes Dec 29, 2018

View reviewed changes

calcsam merged commit e81a216 into gatsbyjs:master Jan 25, 2019

wardpeet pushed a commit that referenced this pull request Feb 11, 2019

docs(authentication-tutorial): use hello-world stater instead of defa…

2a3951f

…ult (#10690) * docs(authentication-tutorial): use hello-world stater instead of default * navBar -> nav-bar

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs(authentication-tutorial): use hello-world stater instead of default #10690

docs(authentication-tutorial): use hello-world stater instead of default #10690

pieh commented Dec 27, 2018 •

edited

KyleAMathews commented Dec 27, 2018

francesmx left a comment

calcsam commented Jan 25, 2019

docs(authentication-tutorial): use hello-world stater instead of default #10690

docs(authentication-tutorial): use hello-world stater instead of default #10690

Conversation

pieh commented Dec 27, 2018 • edited

KyleAMathews commented Dec 27, 2018

francesmx left a comment

Choose a reason for hiding this comment

calcsam commented Jan 25, 2019

pieh commented Dec 27, 2018 •

edited