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

feat(docs): update docs on Guess.js #8899

Merged
merged 14 commits into from
Jan 24, 2019
Merged

Conversation

dlaub3
Copy link
Contributor

@dlaub3 dlaub3 commented Oct 8, 2018

Looking for feedback on this draft. Thanks.
Issue #8846

@dlaub3 dlaub3 requested a review from a team October 8, 2018 00:03
@dlaub3 dlaub3 requested a review from a team as a code owner October 8, 2018 00:03
@amberleyromo
Copy link
Contributor

Hi @dlaub3 -- I checked with other inkteam members, and the proposed title was a bit misleading. This doc should explain what guess.js is, why we'd want to use it, and then link to the gatsby guessjs plugin.

Do you mind making these changes? The beginning of the draft looks like it fits, but just modifying the "usage" part to be more about the plugin.

@dlaub3
Copy link
Contributor Author

dlaub3 commented Oct 18, 2018 via email

@LekoArts
Copy link
Contributor

@amberleyromo @shannonbux
#8846

Example of a guide to imitate: https://www.gatsbyjs.org/docs/deploying-to-s3-cloudfront

Currently this PR looks a lot like the mentioned example. Did you mix some things up here Amberley or should it be rewritten?

@dlaub3 Would you have time to finish this PR once we get feedback on the direction?

@dlaub3
Copy link
Contributor Author

dlaub3 commented Dec 18, 2018

Yes, I'm happy to finish the PR. I just want to be clear on the deliverable first. Thanks.

@shannonbux
Copy link
Contributor

Hi @dlaub3 apologies for getting to this only now; we recently implemented a way for me to automatically get mentioned with changes to the docs.

I have had the same question myself; why have a doc that essentially repeats the READme file for a plugin?

The reason is to increase discoverability of really crucial or prominent plugins. We don't yet have an official list of plugins we want in the docs; they will likely be few in number and mostly focused on official plugins and high-traffic plugins. Eventually we'll also probably want to implement a way of maintaining them easily so they are up-to-date with the READme file.

So the bottom line is this file can be very similar to the READme file for gatsbyjs.org/packages/gatsby-plugin-guess-js with this being the goal (same as what @amberleyromo said): introduce guess.js and give a compelling argument for why someone would want to use it, and then link to the gatsby guessjs plugin. So the article can be relatively short.

@dlaub3
Copy link
Contributor Author

dlaub3 commented Dec 31, 2018

Hi @shannonbux, Thanks for the feedback. I've updated the documentation for this page to be a general introduction to Guess.js and then link to the plugin. Let me know what you think.

Copy link
Contributor

@LekoArts LekoArts left a comment

Choose a reason for hiding this comment

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

Some comments on the text from me.

@shannonbux would need to comment on the title of this doc

Co-Authored-By: dlaub3 <dlaubacher3@gmail.com>
@ibrahimgorashi98
Copy link

Yes that's great

Copy link
Contributor

@shannonbux shannonbux left a comment

Choose a reason for hiding this comment

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

I'll merge this once the three comments have been addressed! Thanks @dlaub3 and @LekoArts!

@dlaub3
Copy link
Contributor Author

dlaub3 commented Jan 20, 2019

@shannonbux I think this is good to go now.

@LekoArts LekoArts added the type: documentation An issue or pull request for improving or updating Gatsby's documentation label Jan 23, 2019
@LekoArts LekoArts dismissed shannonbux’s stale review January 24, 2019 09:36

Changes were addressed

Copy link
Contributor

@wardpeet wardpeet left a comment

Choose a reason for hiding this comment

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

LGTM, thank you for adding this! 🎉

@wardpeet wardpeet changed the title initial Guess.js plugins draft feat(docs): update docs on Guess.js Jan 24, 2019
@wardpeet wardpeet merged commit 5cdc1e7 into gatsbyjs:master Jan 24, 2019
@gatsbot
Copy link

gatsbot bot commented Jan 24, 2019

Holy buckets, @dlaub3 — we just merged your PR to Gatsby! 💪💜

Gatsby is built by awesome people like you. Let us say “thanks” in two ways:

  1. We’d like to send you some Gatsby swag. As a token of our appreciation, you can go to the Gatsby Swag Store and log in with your GitHub account to get a coupon code good for one free piece of swag. (Currently we’ve got a couple t-shirts available, plus some socks that are really razzing our berries right now.)
  2. We just invited you to join the Gatsby organization on GitHub. This will add you to our team of maintainers. Accept the invite by visiting https://github.com/orgs/gatsbyjs/invitation. By joining the team, you’ll be able to label issues, review pull requests, and merge approved pull requests.

If there’s anything we can do to help, please don’t hesitate to reach out to us: tweet at @gatsbyjs and we’ll come a-runnin’.

Thanks again!

wardpeet pushed a commit that referenced this pull request Feb 11, 2019
Looking for feedback on this draft. Thanks.  
Issue #8846 

Co-authored-by: Lennart <lekoarts@gmail.com>
Co-authored-by: shannonbux<32467162+shannonbux@users.noreply.github.com>
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 this pull request may close these issues.

6 participants