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

Gatsby on Linux documentation #4139

Closed
m-allanson opened this issue Feb 20, 2018 · 8 comments
Closed

Gatsby on Linux documentation #4139

m-allanson opened this issue Feb 20, 2018 · 8 comments
Labels
type: documentation An issue or pull request for improving or updating Gatsby's documentation

Comments

@m-allanson
Copy link
Contributor

Create a "Setup Gatsby on Linux" page similar to the Windows docs.

From #4127:

  • incorporate @KyleAMathews comments about mentioning native compilation + Python preqrequisites.
  • And @brainwipe's docs (listed below):

Prerequisites

Starters may use npm plugins that require native node extensions. For those to build, you will need to install build-essential from your package source.

For example, on Debian/Ubuntu:

sudo apt-get install build-essential

@m-allanson m-allanson added the type: documentation An issue or pull request for improving or updating Gatsby's documentation label Feb 20, 2018
@m-allanson m-allanson added this to To do in Documentation Project via automation Feb 20, 2018
@igolden
Copy link

igolden commented Feb 26, 2018

This one started? Up my alley and I could help

@fk
Copy link
Contributor

fk commented Feb 26, 2018

❤️🙏 @igolden Yay! (and no, only what's in #4127)

@spences10
Copy link
Contributor

spences10 commented Mar 25, 2018

I'm checking for Windows Documentation using Windows Subsystem Linux (WSL) if there isn't any in the works I'd like to contribute what I have done for my own personal documentation.

Let me know if I need to raise an issue 👍

Just for info for those that are not aware WSL has been available in Windows 10 via the Windows Store since the Fall Creators Update there will be a very large portion of developers that could use this instead of the song and dance you have to go through installing windows-build-tools and then maybe Visual Studio Community 2015 and Python.

It's basically the Linux install, the documentation goes over using n in place of nvm as nvm is known to slow bash startup on WSL I point to using n-install to get the latest version of node without any permission errors like you get with the official install of node, which isn't sudo apt get node as that installs node legacy @~v4

@m-allanson
Copy link
Contributor Author

m-allanson commented Mar 26, 2018

@spences10 Good idea @spences10 - I think this could make a good section to add to a Gatsby on Linux docs page. Pointing out differences specific to using WSL vs a more traditional flavour of Linux.

Note that sharp (used by gatsby-plugin-sharp) now ships with prebuilt binaries for common platforms, so it's much less common for a platform's build tools to be required for Gatsby projects.

@spences10
Copy link
Contributor

Hey @m-allanson thanks 👍

Is there anything you'd like me to contribute or do you have this on your list?

@m-allanson
Copy link
Contributor Author

I'd love if you wanted to create a Gatsby on Linux docs page? Similar to the Gatsby on Windows page. Even if it's some placeholder content followed by your WSL content that would be great.

The WSL section could cover installing Node correctly along with the build tools. I'd skip anything from your own documentation that veers towards personal preferences :)

@spences10
Copy link
Contributor

Sure, I'll put something together in a PR, thanks 👍

@KyleAMathews
Copy link
Contributor

We did this 👍

Documentation Project automation moved this from To do to Done Sep 8, 2018
DSchau pushed a commit that referenced this issue Nov 7, 2018
Soo in March this year @spences10 opened this PR: #4139
But it never got added to the sidebar 😛 

Therefore I added unknowingly this PR: #8876

-----------

This PR exposes the Linux doc to the sidebar and puts a link to this doc on the windows doc.
gpetrioli pushed a commit to gpetrioli/gatsby that referenced this issue Jan 22, 2019
Soo in March this year @spences10 opened this PR: gatsbyjs#4139
But it never got added to the sidebar 😛 

Therefore I added unknowingly this PR: gatsbyjs#8876

-----------

This PR exposes the Linux doc to the sidebar and puts a link to this doc on the windows doc.
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
5 participants