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

Add an environment variables section to User Guide #1300

Closed
wants to merge 1 commit into from

Conversation

GAumala
Copy link
Contributor

@GAumala GAumala commented Dec 21, 2016

Added new section with 5 environment variables that can be used with npm start:

  • BROWSER
  • HTTPS
  • HOST
  • NODE_PATH
  • PORT

I placed this section right before troubleshooting because I'm not sure were it should go. This documents all the environment variables that I am aware of as well as the new BROWSER variable. I don't have any experience writing user guides so, any criticism is welcome, I'll try to make any changes you request.

Document 5 environment variables that can be used with npm start:

- BROWSER
- HTTPS
- HOST
- NODE_PATH
- PORT
@lucasavila00
Copy link

Hey @GAumala . That's awesome! 👍
But I guess this project is made for beginners too and the whole concept of Env vars may be something new for them. When I started programming I'd see people saying "This is simple. Just set the env var to foo and you're done :)" and I would be like "WAT??????????"
Past me would have read your tutorial and would have no idea what are you talking about. My point is that only mentioning env vars is bad for beginners.

But...
What about using dotenv and in the docs just tell people to change the .env file?
Experienced users would know what you're talking about and beginners won't be scared to change a line in a file. What do you think?
Thanks!

@GAumala
Copy link
Contributor Author

GAumala commented Dec 21, 2016

Yeah, I definitely was thinking more about the advanced users, I pictured this to be something like an appendix. I guess I could add some examples with .env files, although that could make the section longer.

@GAumala
Copy link
Contributor Author

GAumala commented Feb 11, 2017

There's a nice table explaining environment variables, so there's no need for this anymore.

@GAumala GAumala closed this Feb 11, 2017
@gaearon
Copy link
Contributor

gaearon commented Feb 11, 2017

Oh, I’m so sorry we missed this 😢 . I’m sure @Timer didn’t see your PR when he was pushing 0.9.0 and adding that table. The PR list is in a bit of a messy state right now, and some PRs got lost. I’m going through them right now. Again, apologies.

@lock lock bot locked and limited conversation to collaborators Jan 21, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants