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 - added prerequisites #4127

Closed
wants to merge 1 commit into from

Conversation

brainwipe
Copy link

When running npm install on a starter that uses native npm extensions via node-gyp, the user needs to know that they need build-essentials. A clean Ubuntu xenial install won't have it by default.

Closes #4121

When running `npm install` on a starter that uses native npm extensions via `node-gyp`, the user needs to know that they need `build-essentials`. A clean Ubuntu xenial install won't have it by default.

Closes gatsbyjs#4121
@gatsbybot
Copy link
Collaborator

Deploy preview for gatsbygram ready!

Built with commit c87765d

https://deploy-preview-4127--gatsbygram.netlify.com

@fk fk added the type: documentation An issue or pull request for improving or updating Gatsby's documentation label Feb 19, 2018
@@ -20,6 +20,14 @@ This downloads the files and initializes the site by running `npm install`
If you don't specify a custom starter, your site will be created from the
[default starter](https://github.com/gatsbyjs/gatsby-starter-default).

## Prerequisites
Copy link
Contributor

Choose a reason for hiding this comment

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

This is great! Definitely is needed.

I don't think this is the right place for this however — we should have a generic setup Linux for Gatsby pages similar to what we have for Windows https://www.gatsbyjs.org/docs/gatsby-on-windows/

Then this section could link out to those more detailed pages. Probably this section should also hint at the prerequisites e.g. native compilation + Python so people who are running into problems get a hint that they should really go check out the other page in detail for help.

How's that sound?

@brainwipe
Copy link
Author

That sounds ace! However, I no longer have access to a clean Linux install! 😀 For that page to exist, you would need a clean environment to make sure that nothing is missed.

I'm not sure I can proceed with a new ticket for that as my time is very limited. It would definitely be better, though!

@m-allanson
Copy link
Contributor

m-allanson commented Feb 20, 2018

No problem @brainwipe! @brainwipe and @KyleAMathews - so this doesn't get left hanging, I've created a new issue for a 'Setup Gatsby in Linux' page over at #4139.

@m-allanson
Copy link
Contributor

Closing this as it's not going to be merged. @brainwipe your changes will live on in issue #4139 :)

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.

5 participants