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][guides] Docs page for REPL #7484

Closed
kkemple opened this issue Aug 20, 2018 · 12 comments · Fixed by #15309
Closed

[docs][guides] Docs page for REPL #7484

kkemple opened this issue Aug 20, 2018 · 12 comments · Fixed by #15309
Assignees
Labels
type: documentation An issue or pull request for improving or updating Gatsby's documentation

Comments

@kkemple
Copy link
Contributor

kkemple commented Aug 20, 2018

A new repl command was added to Gatsby CLI but it is currently undocumented.

@kkemple kkemple added the type: documentation An issue or pull request for improving or updating Gatsby's documentation label Aug 20, 2018
@gatsbot gatsbot bot added type: documentation type: documentation An issue or pull request for improving or updating Gatsby's documentation labels Aug 20, 2018
@V1shvesh
Copy link

Hey @kkemple!
Can I be assigned to this issue?

@gatsbot gatsbot bot added the stale? Issue that may be closed soon due to the original author not responding any more. label Feb 9, 2019
@gatsbot
Copy link

gatsbot bot commented Feb 9, 2019

Hiya!

This issue has gone quiet. Spooky quiet. 👻

We get a lot of issues, so we currently close issues after 30 days of inactivity. It’s been at least 20 days since the last update here.

If we missed this issue or if you want to keep it open, please reply here. You can also add the label "not stale" to keep this issue open!

Thanks for being a part of the Gatsby community! 💪💜

@gatsbot
Copy link

gatsbot bot commented Feb 20, 2019

Hey again!

It’s been 30 days since anything happened on this issue, so our friendly neighborhood robot (that’s me!) is going to close it.

Please keep in mind that I’m only a robot, so if I’ve closed this issue in error, I’m HUMAN_EMOTION_SORRY. Please feel free to reopen this issue or create a new one if you need anything else.

Thanks again for being part of the Gatsby community!

@marcysutton
Copy link
Contributor

marcysutton commented Feb 27, 2019

@V1shvesh sorry for the delay, yes we would love for you to take this one! I've added a stub for the REPL and some stuff in the CLI docs in a new PR, once it is merged you can start there: #12132

Here's a PR that I found helpful when updating the CLI docs: #7262

@m-allanson m-allanson removed the stale? Issue that may be closed soon due to the original author not responding any more. label Feb 27, 2019
@V1shvesh
Copy link

Awesome! I believe it's merged now.

@V1shvesh
Copy link

V1shvesh commented Mar 2, 2019

Hey @kkemple. Feeling a lil embarassed to admit that I don't have a clue where to start.

I found the list of REPL commands, but I am unable to understand the motivation for such a feature. Please help.

@pieh
Copy link
Contributor

pieh commented Mar 12, 2019

@V1shvesh Original idea came from #6952 and it was implemented in #7484 . For the most part it is to allow examining internal state of Gatsby, without resorting to bunch of console.log or debug breakpoints while Gatsby is doing it's processing.

It might be useful during development/debugging of plugins, but it does require knowledge of Gatsby internals. Or using it can help people understand internals better (depending how you look at it).

@gatsbot
Copy link

gatsbot bot commented Apr 2, 2019

Hiya!

This issue has gone quiet. Spooky quiet. 👻

We get a lot of issues, so we currently close issues after 30 days of inactivity. It’s been at least 20 days since the last update here.

If we missed this issue or if you want to keep it open, please reply here. You can also add the label "not stale" to keep this issue open!

Thanks for being a part of the Gatsby community! 💪💜

@gatsbot gatsbot bot added the stale? Issue that may be closed soon due to the original author not responding any more. label Apr 2, 2019
@lannonbr lannonbr added not stale and removed stale? Issue that may be closed soon due to the original author not responding any more. labels Apr 3, 2019
@marcysutton
Copy link
Contributor

@gatsbyjs/core is there anything we need to do to the Gatsby REPL to get it into shape for proper documentation? It is in the Gatsby CLI doc, but this issue is about filling in the top-level docs page.

@n8finch
Copy link
Contributor

n8finch commented Jun 20, 2019

@marcysutton I'd love to give this a go! It might take me a week or two to get familiar with the commands and such to get some basic documentation together, but then we could go from there.

It seems like I can just break up the commands into different pages, and show examples of how and why you would use each, as well as how this could be combined with the GraphQL explorer to be useful to folks.

I can start with three or four commands and go from there. Thoughts?

@marcysutton
Copy link
Contributor

@n8finch sounds awesome! I think one page would be ideal, though. The work slated in #6896 would help to organize it–in the meantime we're using hard-coded tables of contents like on this doc: https://github.com/gatsbyjs/gatsby/blob/master/docs/docs/gatsby-image.md#in-this-doc

@n8finch
Copy link
Contributor

n8finch commented Jun 20, 2019

@marcysutton perfect, I'll get to work on this! If the issue is quiet for a bit, don't worry, I'm still working... 🤓

@marisamorby marisamorby changed the title [v2] Docs page for REPL [docs][guides] Docs page for REPL Jul 11, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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.

9 participants