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

Make contributing instructions consistent #8920

Merged

Conversation

siakaramalegos
Copy link
Contributor

Connects #8676

Changes instructions from gatsby develop to yarn develop to ensure contributors are using the local version of gatsby.

Adds instructions for contributing to the starter showcase into the main contributing instructions since a contributor might not know to also look in www/readme.md for separate instructions.

@siakaramalegos siakaramalegos requested a review from a team October 8, 2018 20:42
@siakaramalegos siakaramalegos requested a review from a team as a code owner October 8, 2018 20:42
@siakaramalegos
Copy link
Contributor Author

I still can't get the docs/www site to work locally in development, so I can't verify these changes don't break anything.

@amberleyromo
Copy link
Contributor

@siakaramalegos:

I still can't get the docs/www site to work locally in development

if memory serves, i believe the issue you reported last time has been fixed. Can you provide more detail about the error you're seeing?

@siakaramalegos
Copy link
Contributor Author

@amberleyromo I don't know the root cause, but I still get the GraphQL error on build, and the main page plus most pages are not viewable (lots of errors in the console). I never added at GitHub key since the last I remembered in that other ticket was to make the build functional without having to do that (since it was only needed for the starter library).

@amberleyromo
Copy link
Contributor

@siakaramalegos have you deleted the cache? if yes, i'll take a look later tonight when i can get to it!

@siakaramalegos
Copy link
Contributor Author

@amberleyromo I went ahead and re-pulled this master, deleted www/.cache/ and re-ran yarn develop. Unfortunately, it still has the same problem for me.

@@ -76,13 +76,25 @@ a pull request.

- Clone the repo and navigate to `/www`
- Run `yarn` to install all of the website's dependencies.
- Run `gatsby develop` to preview the website in `http://localhost:8000`
- Run `yarn develop` to preview the website in `http://localhost:8000`
Copy link
Contributor

Choose a reason for hiding this comment

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

This isn't necessary as gatsby develop always runs the local version

@jlengstorf
Copy link
Contributor

jlengstorf commented Oct 8, 2018

@siakaramalegos Are you still getting the same errors as in #5073?

I just verified that I do not have a .env set up, pulled the latest from master, and was able to get the site running.

To be extra super sure that the site at master is building, I did a fresh clone and it built properly.

Full output from clone and run
@jlengstorf: ~/dev/tmp/gatsby/www  (master)
$ node -v
v10.1.0

@jlengstorf: ~/dev/tmp/gatsby/www  (master)
$ yarn -v
1.9.4

@jlengstorf: ~/dev/tmp/gatsby/www  (master)
$ npm -v
5.6.0

@jlengstorf: ~/dev/tmp  (master)
$ git clone [email protected]:gatsbyjs/gatsby.git --depth=1
Cloning into 'gatsby'...
remote: Enumerating objects: 3355, done.
remote: Counting objects: 100% (3355/3355), done.
remote: Compressing objects: 100% (2817/2817), done.
remote: Total 3355 (delta 472), reused 1998 (delta 259), pack-reused 0
Receiving objects: 100% (3355/3355), 189.16 MiB | 23.17 MiB/s, done.
Resolving deltas: 100% (472/472), done.
Checking out files: 100% (3005/3005), done.

@jlengstorf: ~/dev/tmp  (master)
$ cd gatsby/www/

@jlengstorf: ~/dev/tmp/gatsby/www  (master)
$ yarn
yarn install v1.9.4
(node:25037) ExperimentalWarning: The fs.promises API is experimental
info No lockfile found.
[1/4] 🔍  Resolving packages...
warning gatsby-plugin-sharp > imagemin-mozjpeg > mozjpeg > bin-build > download > gulp-decompress > [email protected]: gulp-util is deprecated - replace it, following the guidelines at https://medium.com/gulpjs/gulp-util-ca3b1f9f9ac5
warning webshot > [email protected]: please upgrade to graceful-fs 4 for compatibility with current and future versions of Node.js
[2/4] 🚚  Fetching packages...
[----------------------------------------------------------------------] 0/2192(node:25037) [DEP0005] DeprecationWarning: Buffer() is deprecated due to security and usability issues. Please use the Buffer.alloc(), Buffer.allocUnsafe(), or Buffer.from() methods instead.
[3/4] 🔗  Linking dependencies...
warning "gatsby-plugin-lodash > [email protected]" has unmet peer dependency "webpack@^2.0.0 || ^3.0.0 || ^4.0.0".
warning "gatsby-plugin-netlify > [email protected]" has unmet peer dependency "webpack@>=4.4.0".
warning "react-icons > [email protected]" has unmet peer dependency "prop-types@*".
warning " > [email protected]" has incorrect peer dependency "typography@^1.0.0".
warning " > [email protected]" has unmet peer dependency "opentracing@*".
[4/4] 📃  Building fresh packages...
success Saved lockfile.
✨  Done in 44.41s.

@jlengstorf: ~/dev/tmp/gatsby/www  (master)
$ yarn develop
yarn run v1.9.4
(node:25302) ExperimentalWarning: The fs.promises API is experimental
$ gatsby develop
(node:25303) ExperimentalWarning: The fs.promises API is experimental
success open and validate gatsby-config — 0.009 s
success load plugins — 0.343 s
success onPreInit — 1.444 s
success delete html and css files from previous builds — 0.011 s
success initialize cache — 0.019 s
success copy gatsby files — 0.056 s
success onPreBootstrap — 0.011 s
success source and transform nodes — 45.230 s
success building schema — 1.472 s
success createPages — 8.184 s
success createPagesStatefully — 0.355 s
success onPreExtractQueries — 0.004 s
success update schema — 0.841 s
success extract queries from components — 0.446 s
success run graphql queries — 88.188 s — 1292/1292 14.65 queries/second
success write out page data — 0.026 s
success write out redirect data — 0.001 s
Generating image thumbnails [=======================] 7954/7954 1380.4 secs 100%

info bootstrap finished - 1443.602 s

⠄ onPostBootstrapdone generating icons for manifest
success onPostBootstrap — 0.145 s
(node:25305) ExperimentalWarning: The fs.promises API is experimental
 DONE  Compiled successfully in 7774ms                                  16:04:57


You can now view gatsbyjs.org in the browser.

  http://localhost:8000/

View GraphiQL, an in-browser IDE, to explore your site's data and schema

  http://localhost:8000/___graphql

Note that the development build is not optimized.
To create a production build, use gatsby build

boundActionCreators is deprecated. Please use actions instead. For migration instructions, see https://gatsby.app/boundActionCreators
Check the following files:

src/pages/docs/actions.js

ℹ 「wdm」:
ℹ 「wdm」: Compiled successfully.


If this is still happening to you, there are a few things that I've seen cause issues in the past:

  1. yarn.lock could be causing issues. Sometimes deleting it and doing a fresh yarn install resolves the problem.
  2. If that doesn't work, deleting the /www/.cache directory sometimes clears things up. Looks like you've tried that already.
  3. In the worst-case scenario, going nuclear is sometimes the only thing that's worked for me:
    rm -rf public/ .cache/ node_modules/ yarn.lock package-lock.json
    yarn
    yarn develop
    

If you're still running into issues, could you please open a new issue with the errors you're seeing? Thanks so much!

@siakaramalegos
Copy link
Contributor Author

The nuclear option worked! Verified that this looks ok...

image

@amberleyromo
Copy link
Contributor

Glad we could get it sorted, @siakaramalegos! Thanks @jlengstorf for troubleshooting/verifying.

@siakaramalegos, could you handle the tweak from @KyleAMathews previous review? Then we should be good to go. Thanks!

@siakaramalegos
Copy link
Contributor Author

@amberleyromo @KyleAMathews switched to gatsby develop in both locations (each location had a different version of the command before)

Copy link
Contributor

@amberleyromo amberleyromo left a comment

Choose a reason for hiding this comment

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

👍

@amberleyromo amberleyromo merged commit bc40a4b into gatsbyjs:master Oct 9, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants