Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] move building client only routes into its own guide #16133

Closed
gillkyle opened this issue Jul 26, 2019 · 10 comments · Fixed by #16391
Closed

[docs] move building client only routes into its own guide #16133

gillkyle opened this issue Jul 26, 2019 · 10 comments · Fixed by #16391
Labels
good first issue Issue that doesn't require previous experience with Gatsby help wanted Issue with a clear description that the community can help with. type: documentation An issue or pull request for improving or updating Gatsby's documentation

Comments

@gillkyle
Copy link
Contributor

gillkyle commented Jul 26, 2019

Description

The guide on client only routes and user authentication is an important enough guide to be its own page.

Another issue came up while working on #15979, linking to the subheading for client only routes in the "Building Apps with Gatsby" page means if we change the subheading's title the links in other places will break, making that link very fragile, and giving us reason to turn it into its own page.

Action Steps

@gillkyle gillkyle added help wanted Issue with a clear description that the community can help with. type: documentation An issue or pull request for improving or updating Gatsby's documentation good first issue Issue that doesn't require previous experience with Gatsby labels Jul 26, 2019
@sedat
Copy link

sedat commented Jul 27, 2019

I can take on this!

@marcysutton
Copy link
Contributor

One other thing I would add is that we should still mention client-only routes on the Building Apps with Gatsby page, and link to the new standalone page for more information.

@marcysutton
Copy link
Contributor

Also, sounds great @sedat!

@Jhony0311
Copy link
Contributor

Jhony0311 commented Aug 2, 2019

@marcysutton @sedat Is okay if I take this? Already created the new page and waiting on #15979 to be merged. Is okay to open a PR?

@marcysutton
Copy link
Contributor

@Jhony0311 that sounds cool to me! It might be smart to wait until #16309 is merged, even though #15979 is in already. Hopefully should be done today.

@sedat
Copy link

sedat commented Aug 2, 2019

@marcysutton @Jhony0311 totally fine for me as I haven't had a change because of work and was thinking of finishing it this weekend.

@Jhony0311
Copy link
Contributor

Jhony0311 commented Aug 5, 2019

@marcysutton Should I update every reference on other files as well? I did a quick search and I see this references:

  • docs/docs/routing.md
  • docs/blog/2018-11-07-gatsby-for-apps/index.md
  • packages/gatsby-plugin-netlify/README.md

I imagine the plugin and the blog post don't apply but routing seems like a yes to me.

Also could this updates be a redirect maybe?

@gillkyle
Copy link
Contributor Author

gillkyle commented Aug 6, 2019

Oh just merged the PR (thanks @Jhony0311!) to make those a new guide, but if those links:

  • docs/docs/routing.md
  • docs/blog/2018-11-07-gatsby-for-apps/index.md
  • packages/gatsby-plugin-netlify/README.md

are broken we should update them yes! If either of you two: @sedat or @Jhony0311 are interested a PR to update those would be awesome, if not I'm sure someone else would be happy to pick it up!

@Jhony0311
Copy link
Contributor

Jhony0311 commented Aug 6, 2019

Happy to take that, I can go ahead and update that. Should I do all three @gillkyle ? Just want to make sure that's okay.

@gillkyle
Copy link
Contributor Author

gillkyle commented Aug 6, 2019

@Jhony0311 yeah it makes sense to have them all in one PR thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Issue that doesn't require previous experience with Gatsby help wanted Issue with a clear description that the community can help with. type: documentation An issue or pull request for improving or updating Gatsby's documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants