Adding minor getting started clarifications #2798
Conversation
Clarify that v4 needs webpack *and* webpack-cli
| To disambiguate in your `webpack.config.js` between [development](/guides/development) and [production builds](/guides/production) you may use environment variables. | ||
| To disambiguate in your `webpack.config.js` between [development](/guides/development) and [production builds](/guides/production) you may use "environment variables". | ||
|
|
||
| T> webpack's environment variables are different from the [environment variables](https://en.wikipedia.org/wiki/Environment_variable) you might be used to from the shell where you're running webpack |
There was a problem hiding this comment.
i don't think that quoting them before and putting war here is correct, can you remove the quotes above.
There was a problem hiding this comment.
I was aiming to use quotations to indicate uncommon usage (see https://style.mla.org/quotes-when-nothing-is-being-quoted/), but I'm fine with getting rid of them.
There was a problem hiding this comment.
Yes i understand, but it looked weird when i read through that version of the page, same term with different styling in sibling paragraphs... Another thing here is that we are doing an assumption in the docs. Recently we'd received many PRs removing such statements. Can we get rid of you might be .... and just state the facts
There was a problem hiding this comment.
Changed. I understand the rationale (for example, this commit is fantastic: be90987), but in this case, I think it might be slightly worse, since the sentence is referring to a concept unrelated to webpack. My use of the phrase "you might be used to from" was intended to cause readers unfamiliar with the idea of environment variables and operating system shells to disregard the tip. Now such a reader needs to confront their own level of understanding with the concept of shells and environment variables (i.e. it's making the assumption that they know what a shell is).
There was a problem hiding this comment.
On a related note, the writing contribution guide makes no mention of writing style. It would be great if a maintainer could edit it to provide examples of phrasing that would or would not be appropriate, based on the design goals of the documentation.
There was a problem hiding this comment.
Very good point! that is tbd soon
Co-Authored-By: jceipek <jceipek@gmail.com>
|
Thanks! |
I'm just trying out webpack and the installation and environment variables sections threw me off a bit. Hopefully these minor changes will help others avoid my confusion.
The installation section explains that you need to install the cli for webpack 4 but could be clearer that this is in addition to the
webpackpackage. I added "also".The environment variables section does not make clear that webpack's environment variables are separate from the environment variables I might set in
bash,fish,zsh, etc... I added a tip to that effect.