Gatsby: Add a11y section to the docs

Created on 29 May 2018  路  7Comments  路  Source: gatsbyjs/gatsby

good first issue documentation

Most helpful comment

Hello, coming from the React podcast @jlengstorf 馃槃

I can do this I believe, just to confirm what needs to be done:

  • Create a the new page under the "Adding website functionality doc page" and migrate the content from the blog post to that page (just copy paste and formatting ?).
  • Add to the blog post a link to this new section.

Anything else ? Does the new page only have the blog post content (or only part of it ?) ?

All 7 comments

We can do this now!

  • @amberleyromo wrote a great guide here: https://www.gatsbyjs.org/blog/2018-09-27-reach-router/ which has a lot of good content to be ported over.
  • This should live in the docs as a child of the https://www.gatsbyjs.org/docs/adding-website-functionality/ doc.
  • This PR should also add a link in Amberley's blog post to the new section in the docs.

Tagging this as a "good first issue" for a new contributor!

Hello, coming from the React podcast @jlengstorf 馃槃

I can do this I believe, just to confirm what needs to be done:

  • Create a the new page under the "Adding website functionality doc page" and migrate the content from the blog post to that page (just copy paste and formatting ?).
  • Add to the blog post a link to this new section.

Anything else ? Does the new page only have the blog post content (or only part of it ?) ?

Hey @enzoferey! Awesome to see you headed here from the podcast :)

  • Yep! Create a new page (I'd call it something like "Making your site accessible" -- "Adding accessibility" sounds weird to me)
  • I wouldn't copy paste the post directly -- use and repurpose parts of the post that are helpful as a doc. I'd suggest:
  1. Check out the Gatsby style guide and skim through a couple other docs in the section.
  2. Draft the doc:

    • Add an introduction about accessibility in general.

    • Then, dive more into accessibility with Gatsby, using the @reach/router post as source material (but rewrite as necessary to make it a doc, rather than a blog post).

How does that sound? This is a good starting point, and the doc will continue to evolve!

Sounds good, I'm doing it !

Can this issue be closed since there is an accessibility page? Love seeing this :) https://www.gatsbyjs.org/docs/making-your-site-accessible/

I guess so !

@marcysutton good call. Thanks!

Was this page helpful?
0 / 5 - 0 ratings

Related issues

theduke picture theduke  路  3Comments

dustinhorton picture dustinhorton  路  3Comments

rossPatton picture rossPatton  路  3Comments

Oppenheimer1 picture Oppenheimer1  路  3Comments

magicly picture magicly  路  3Comments