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.

Sign up for GitHub

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

Jump to bottom

Update "Deploying with Now" Guide #10390

Merged
merged 8 commits into from
Dec 10, 2018
Merged

Update "Deploying with Now" Guide #10390

merged 8 commits into from
Dec 10, 2018

Conversation

timothyis
Copy link
Contributor

Hello!

This pull request updates the "Deploying with Now" guide to give information about how to deploy with Now 2.0. It is a more straight-forward guide than before an holds the most up-to-date information.

Please let me know if I can edit this guide further in any way.
I took example from other guides you have and followed the styleguide as closely as I could. 🙏

@timothyis timothyis requested a review from a team December 10, 2018 16:53
jgierer12
jgierer12 reviewed Dec 10, 2018
View reviewed changes
docs/docs/deploying-to-now.md Outdated Show resolved Hide resolved
docs/docs/deploying-to-now.md Outdated Show resolved Hide resolved
docs/docs/deploying-to-now.md Outdated Show resolved Hide resolved
docs/docs/deploying-to-now.md Show resolved Hide resolved
docs/docs/deploying-to-now.md Outdated Show resolved Hide resolved
@timothyis
Copy link
Contributor Author

Thanks for the review @jgierer12! I've addressed your comments, however, I opted to keep a highlighted spot for installing Now CLI via npm since it's often a choice a user wants to take to get through a tutorial as quickly as possible, I've found.

I'm happy to change that again if you'd prefer though!

DSchau
DSchau reviewed Dec 10, 2018
View reviewed changes
Copy link
Contributor

@DSchau DSchau left a comment

Choose a reason for hiding this comment

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

Looks great! Left a few comments :)

docs/docs/deploying-to-now.md Outdated Show resolved Hide resolved
docs/docs/deploying-to-now.md Outdated Show resolved Hide resolved
docs/docs/deploying-to-now.md Outdated Show resolved Hide resolved
docs/docs/deploying-to-now.md Outdated Show resolved Hide resolved
@timothyis
Copy link
Contributor Author

Thanks @DSchau! Greatly appreciate the suggestions 😄
Great point on the long sentence, much more readable now.

DSchau
DSchau approved these changes Dec 10, 2018
View reviewed changes
Copy link
Contributor

@DSchau DSchau left a comment

Choose a reason for hiding this comment

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

Looks great! One final comment--do you think it's worth linking (anywhere) to the now example?

e.g. this example

@timothyis
Copy link
Contributor Author

timothyis commented Dec 10, 2018 •
edited
Loading

@DSchau I did include a reference to it at the bottom, as I saw your s3 deployment guide had something similar, however, I'm happy to incorporate it more into the content if you'd like.
https://github.com/gatsbyjs/gatsby/pull/10390/files#diff-847fa9e659a8af2357ccc57be66bc3cdR80

@DSchau
Copy link
Contributor

DSchau commented Dec 10, 2018

@timothyis I missed it! That's perfect, makes a lot of sense.

Merging; thanks so much for the PR 🎉

@DSchau DSchau merged commit 2ca32e5 into gatsbyjs:master Dec 10, 2018
@gatsbot
Copy link

gatsbot bot commented Dec 10, 2018

Holy buckets, @timothyis — 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!

@timothyis timothyis deleted the patch-1 branch December 10, 2018 21:39
@timothyis
Copy link
Contributor Author

Thank you!

m-allanson added a commit to Bouncey/gatsby that referenced this pull request Dec 10, 2018
@m-allanson
Merge branch 'master' into feat/no-watch-on-build
9b710e7 
* master: (35 commits)
  feat(gatsby-source-filesystem): keep original name of remote files (gatsbyjs#9777)
  docs(gatsby-source-contentful): Rewrite of gatsby-source-contentful query section (gatsbyjs#7533)
  Update "Deploying with Now" Guide (gatsbyjs#10390)
  Add Matomo to list of analytics plugins (gatsbyjs#10372)
  Add satispay.com to showcase (gatsbyjs#10380)
  Adds @goblindegook/gatsby-starter-typescript (gatsbyjs#10377)
  Fix typo in gatsby-remark-code-repls sample `gatsby-config.json` in README (gatsbyjs#10361)
  fix(gatsby): fix false type conflict warning on plugin fields (gatsbyjs#10355)
  fix(docs): Just a small typo fix in the docs (gatsbyjs#10359)
  feat(gatsby-image): add onStartLoad prop  (gatsbyjs#6702)
  fix(docs): add Ecosystem to docs sidebar, consistency with tutorial sidebar (gatsbyjs#10350)
  fix(www): Starters.yaml housekeeping (gatsbyjs#10354)
  docs: add ttag starter (gatsbyjs#10352)
  docs: document branching (gatsbyjs#9983)
  plugin checker initial commit (gatsbyjs#7062)
  docs: new starter features is required (gatsbyjs#10353)
  docs: migrated line highlighting to highlight-line, highlight-start, highlight-end (gatsbyjs#10202)
  Add Birra Napoli to site showcase (gatsbyjs#10344)
  Add BetterDocs to site showcase (gatsbyjs#10349)
  chore(release): Publish
  ...
shannonbux
shannonbux reviewed Dec 11, 2018
View reviewed changes
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.

This looks stellar, @timothyis! Thanks. Just left a couple comments; I know I'm a bit late to the party :)

docs/docs/deploying-to-now.md

With Now CLI installed, we can go on to deploy our previously setup Gatsby project by first creating a `now.json` file with the following contents:

```json:title=now.json
Copy link
Contributor

Choose a reason for hiding this comment

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

is this at the root of the project?

docs/docs/deploying-to-now.md
- Set the project name to `my-gatsby-project`
- Use the [@now/static-build builder](https://zeit.co/docs/v2/deployments/official-builders/static-build-now-static-build/) to take the `package.json` file as an entrypoint and use the `public` directory as the our content directory

The final step is to add a script to the `package.json` which will build our application:
Copy link
Contributor

Choose a reason for hiding this comment

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

*your application

m-allanson added a commit to markza/gatsby that referenced this pull request Dec 11, 2018
@m-allanson
Merge branch 'master' into fix/contentful-images-url-http-included
a3e1ea5 
* master: (1432 commits)
  chore(release): Publish
  Fix Starter Library URL and update copy (gatsbyjs#10368)
  feat(gatsby-source-filesystem): keep original name of remote files (gatsbyjs#9777)
  docs(gatsby-source-contentful): Rewrite of gatsby-source-contentful query section (gatsbyjs#7533)
  Update "Deploying with Now" Guide (gatsbyjs#10390)
  Add Matomo to list of analytics plugins (gatsbyjs#10372)
  Add satispay.com to showcase (gatsbyjs#10380)
  Adds @goblindegook/gatsby-starter-typescript (gatsbyjs#10377)
  Fix typo in gatsby-remark-code-repls sample `gatsby-config.json` in README (gatsbyjs#10361)
  fix(gatsby): fix false type conflict warning on plugin fields (gatsbyjs#10355)
  fix(docs): Just a small typo fix in the docs (gatsbyjs#10359)
  feat(gatsby-image): add onStartLoad prop  (gatsbyjs#6702)
  fix(docs): add Ecosystem to docs sidebar, consistency with tutorial sidebar (gatsbyjs#10350)
  fix(www): Starters.yaml housekeeping (gatsbyjs#10354)
  docs: add ttag starter (gatsbyjs#10352)
  docs: document branching (gatsbyjs#9983)
  plugin checker initial commit (gatsbyjs#7062)
  docs: new starter features is required (gatsbyjs#10353)
  docs: migrated line highlighting to highlight-line, highlight-start, highlight-end (gatsbyjs#10202)
  Add Birra Napoli to site showcase (gatsbyjs#10344)
  ...
m-allanson added a commit to alexkirsz/gatsby that referenced this pull request Dec 12, 2018
@m-allanson
Merge branch 'master' into topics/gatsby-image-hide-base64
837afbd 
* master: (1425 commits)
  showcase: Add TMDb Gatsby site (gatsbyjs#10411)
  chore(www): bump offline plugin version (gatsbyjs#10409)
  chore(release): Publish
  Fix Starter Library URL and update copy (gatsbyjs#10368)
  feat(gatsby-source-filesystem): keep original name of remote files (gatsbyjs#9777)
  docs(gatsby-source-contentful): Rewrite of gatsby-source-contentful query section (gatsbyjs#7533)
  Update "Deploying with Now" Guide (gatsbyjs#10390)
  Add Matomo to list of analytics plugins (gatsbyjs#10372)
  Add satispay.com to showcase (gatsbyjs#10380)
  Adds @goblindegook/gatsby-starter-typescript (gatsbyjs#10377)
  Fix typo in gatsby-remark-code-repls sample `gatsby-config.json` in README (gatsbyjs#10361)
  fix(gatsby): fix false type conflict warning on plugin fields (gatsbyjs#10355)
  fix(docs): Just a small typo fix in the docs (gatsbyjs#10359)
  feat(gatsby-image): add onStartLoad prop  (gatsbyjs#6702)
  fix(docs): add Ecosystem to docs sidebar, consistency with tutorial sidebar (gatsbyjs#10350)
  fix(www): Starters.yaml housekeeping (gatsbyjs#10354)
  docs: add ttag starter (gatsbyjs#10352)
  docs: document branching (gatsbyjs#9983)
  plugin checker initial commit (gatsbyjs#7062)
  docs: new starter features is required (gatsbyjs#10353)
  ...
gpetrioli pushed a commit to gpetrioli/gatsby that referenced this pull request Jan 22, 2019
@timothyis @gpetrioli
Update "Deploying with Now" Guide (gatsbyjs#10390)
c50297c 
* Update the Now guide to use Now v2

* Add reference

* Address review comments

* Update docs/docs/deploying-to-now.md

Co-Authored-By: timothyis <[email protected]>

* Update docs/docs/deploying-to-now.md

Co-Authored-By: timothyis <[email protected]>

* Update docs/docs/deploying-to-now.md

Co-Authored-By: timothyis <[email protected]>

* Update docs/docs/deploying-to-now.md

Co-Authored-By: timothyis <[email protected]>

* Update deploying-to-now.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@shannonbux shannonbux shannonbux left review comments

@jgierer12 jgierer12 jgierer12 left review comments

@DSchau DSchau DSchau approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@timothyis @DSchau @jgierer12 @shannonbux