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

Add REPL documentation to the Gatsby Docs #15309

Merged
merged 11 commits into from
Jul 12, 2019
Merged

Add REPL documentation to the Gatsby Docs #15309

merged 11 commits into from
Jul 12, 2019

Conversation

n8finch
Copy link
Contributor

@n8finch n8finch commented Jul 2, 2019

Description

Currently [WIP], this PR creates documentation for the Gatsby CLI REPL shell. This was merged in #7262, but didn't include documentation.

I've labeled this [WIP] because I'd like feedback on the format and content of the documentation:

  1. Are the explanations clear?
  2. Are the examples helpful?

I just want to make sure 🤓.

Once I get feedback, I'll finish up the docs for a merge.

Also, it looks like the dataPaths command is throwing an error? But I'll double check on that and file a bug issue (and hopefully a PR to fix it!) after the docs.

Related Issues

Fixes #7484

@n8finch n8finch requested a review from a team as a code owner July 2, 2019 12:34
@n8finch n8finch requested a review from a team July 2, 2019 12:34
@n8finch n8finch added the type: documentation An issue or pull request for improving or updating Gatsby's documentation label Jul 2, 2019
@lannonbr
Copy link
Contributor

lannonbr commented Jul 2, 2019

Thanks for the work so far @n8finch! Just a thing to do is since you are fleshing out this stub, I would recommend removing the asterisk for the gatsby-repl entry in the sidebar as it is no longer going to be a stub. It can be found in the sidebar yaml file located in www/src/data/sidebars/doc-links.yaml. Here's the file in the master branch: https://github.com/gatsbyjs/gatsby/blob/master/www/src/data/sidebars/doc-links.yaml

@n8finch n8finch requested a review from a team as a code owner July 2, 2019 13:48
@n8finch
Copy link
Contributor Author

n8finch commented Jul 2, 2019

@lannonbr thanks for the heads up, I'd completely missed that! 👍

@n8finch
Copy link
Contributor Author

n8finch commented Jul 2, 2019

Hmm, I'm showing some CircleCI tests failing... When I look at the details, I'm not sure what went wrong. Do I need to run gatsby build to compile in the yaml updates?

@lannonbr
Copy link
Contributor

lannonbr commented Jul 2, 2019

Hmm, I'm showing some CircleCI tests failing... When I look at the details, I'm not sure what went wrong. Do I need to run gatsby build to compile in the yaml updates?

So there's 502 bad gateway errors coming up. Cloudflare is having some outages today and NPM is affected by such, so it's no issue on your end

Copy link
Contributor

@gillkyle gillkyle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I know you mentioned this is still a WIP PR but I think it's looking great! I'd never used the REPL before this but I think you give good examples.

I made a couple little suggestions, really appreciate your work on this @n8finch!

@n8finch n8finch changed the title [WIP] Add REPL documentation to the Gatsby Docs Add REPL documentation to the Gatsby Docs Jul 7, 2019
@n8finch
Copy link
Contributor Author

n8finch commented Jul 7, 2019

Hey @gillkyle, thanks for the review and the corrections! I've never been the best speller 😂.

I've pushed up a new commit now with those changes.

I've also removed the WIP and added more documentation here.

It looks like there might be some tests failing, which I'm not sure how to resolve. Any pointers?

Thanks again!

@gillkyle
Copy link
Contributor

Awesome! Thanks @n8finch! Those additional updates look awesome 😄

As far as tests go, it looks like CircleCI is complaining about linting, I think the command from this doc might be enough:

npm run format

and then push the changes. Seems like the offending file is docs/docs/gatsby-repl.md.

I've seen the windows tests just kind of fail for no real obvious reason, so pushing some change might just be enough for them to run again and maybe work. Might have to look into those more if they keep failing.

gillkyle
gillkyle previously approved these changes Jul 10, 2019
@n8finch
Copy link
Contributor Author

n8finch commented Jul 11, 2019

@gillkyle Woohoo! That worked... Hahaha.. Machines... Thanks!

@n8finch n8finch requested a review from a team as a code owner July 12, 2019 02:43
Copy link
Contributor

@gillkyle gillkyle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks so much @n8finch! Appreciate you iterating on this several times to get everything really solid 😄

@gillkyle gillkyle added the bot: merge on green Gatsbot will merge these PRs automatically when all tests passes label Jul 12, 2019
@gillkyle gillkyle merged commit 94345ea into gatsbyjs:master Jul 12, 2019
@n8finch
Copy link
Contributor Author

n8finch commented Jul 12, 2019

Thanks for your help @gillkyle , @lannonbr , and @muescha ! I learned a lot!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bot: merge on green Gatsbot will merge these PRs automatically when all tests passes type: documentation An issue or pull request for improving or updating Gatsby's documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[docs][guides] Docs page for REPL
4 participants