Let's ship the webpack 4 documentation #1856

sokra · 2018-02-26T07:24:25Z

Merge the next branch.

…placeholder

This moves some of the content from `compiler.md` and brings it into the main node api documentation in order to allow `compiler.md` to become `compiler-hooks.md` which fits better in the context of plugins.

…le.md` This moves some of the `Tapable` discussion to the lead-in `plugins.md` to prevent doc duplication. Instead of redocumenting the `tapable` package, we should focus on improving the README and simply link to there throughout our docs. As I've mentioned before, we can also create a "Utilities" section for things other than "Loaders" and "Plugins" that we want to dynamically pull in.

These guides were full of todos and probably lead to more confusion than clarity. We can discuss more and add them back in once there's a clear flow for how to incorporate and document them.

This page now focuses specifically on the `hooks` as all the non-plugin related content was moved to `node.md`. I updated the hooks to the new syntax, added all undocumented hooks, reformatted each hook as a section to allow more breathing room, and clarified exactly which `tapable` hook is used for each section. Still need to get more info on some of the new hooks before we can ship this...

This page now uses the same section setup as `compiler-hooks.md` and is up to date with the latest hooks available in the webpack 4 alpha release.

Improve lead-in to give a little more context on what the parser does. Add the latest hooks and use the same layout as the other pages in the section.

Updates the Get Started guide to use webpack 4 and adds some additional information about npm.

Update the plugins page in the concepts section to be compatible with webpack 4. Also adds a note about referencing the plugin name in camel-case when calling the `tap` method.

skipjack · 2018-03-03T18:00:49Z

We should definitely merge soon but whoever does please tag master with the latest v3 version so we can easily grab the last stable v3 docs if version switching (via a dropdown or something) is ever added.

This adds the `builtAt` option to the example configuration.

This adds valid doctypes to all the HTML examples in the Get Started guide.

This adds a table of config options for v4 to the API documentation.

montogeek · 2018-03-14T17:56:45Z

@TheLarkInn What you think about versioning the website?
We could also setup Netlify or just deploy current master on GH pages under a subdirectory 3 for example.

dhruvdutt · 2018-03-15T08:25:15Z

src/content/api/plugins.md

-T> For a high-level introduction to writing plugins, start with [writing a plugin](/contribute/writing-a-plugin).
+Plugins are a key piece of the webpack ecosystem and provide the community with
+a powerful way to tap into webpack's compilation process. A plugin is able to
+[hook]() into key events that are fired throughout each compilation. Every step


[hook]() Missing a link here?

dhruvdutt · 2018-03-15T08:38:27Z

src/content/concepts/index.md

 ---

 At its core, *webpack* is a _static module bundler_ for modern JavaScript applications. When webpack processes your application, it recursively builds a _dependency graph_ that includes every module your application needs, then packages all of those modules into one or more _bundles_.

 T> Learn more about JavaScript modules and webpack modules [here](/concepts/modules).

-It is [incredibly configurable](/configuration), but to get started you only need to understand four **Core Concepts**:
+Since v4.0.0 webpack does not require a configuration file. Nevertheless, it is [incredibly configurable](/configuration). To get started you only need to understand four **Core Concepts**:


Can we rephrase this better? Maybe include "0CJS"?

dhruvdutt · 2018-03-15T08:41:53Z

src/content/concepts/index.md

@@ -31,7 +32,7 @@ An **entry point** indicates which module webpack should use to begin building o

 Every dependency is then processed and outputted into files called *bundles*, which we'll discuss more in the next section.

-You can specify an entry point (or multiple entry points) by configuring the `entry` property in the [webpack configuration](/configuration).
+You can specify an entry point (or multiple entry points) by configuring the `entry` property in the [webpack configuration](/configuration). It defaults to `./src`.


We should clearly mention the default filename along with directory. ./src/index.js

dhruvdutt · 2018-03-15T08:42:24Z

src/content/concepts/index.md

@@ -48,7 +49,7 @@ T> You can configure the `entry` property in various ways depending the needs of

 ## Output

-The **output** property tells webpack where to emit the *bundles* it creates and how to name these files. You can configure this part of the process by specifying an `output` field in your configuration:
+The **output** property tells webpack where to emit the *bundles* it creates and how to name these files and defaults to `./dist`. You can configure this part of the process by specifying an `output` field in your configuration:


We should clearly mention the default filename along with directory. ./dist/bundle.js

dhruvdutt · 2018-03-15T08:45:18Z

src/content/concepts/mode.md

+or pass it as a cli argument:
+
+```bash
+webpack --mode=production


--mode production

Can we also mention the precedence of mode if it's present in both config and via cli?

--mode=production is valid too

--mode production looks cleaner to me. Anyways, either is fine. 👍

dhruvdutt · 2018-03-15T08:59:23Z

src/content/guides/getting-started.md

@@ -144,20 +177,25 @@ In this setup, `index.js` explicitly requires `lodash` to be present, and binds
 With that said, let's run `npx webpack` with our script as the [entry point](/concepts/entry-points) and `bundle.js` as the [output](/concepts/output). The `npx` command, which ships with Node 8.2 or higher, runs the webpack binary (`./node_modules/.bin/webpack`) of the webpack package we installed in the beginning:


We should add a note or command here for users using Node < 8.2.

update tree shaking guide for webpack 4

dhruvdutt

We need to remove package-lock.json #1917
We already have a yarn.lock file. Keeping both lock files would create sync issues.

* chore: clean package-lock.json * chore: sync yarn.lock

* correct a path error in example

TheLarkInn · 2018-03-19T17:24:35Z

Looks like a tree shaking guide is still conflicting. Does anyone want to grab those conflicts?

dhruvdutt · 2018-03-19T17:31:03Z

@TheLarkInn Already resolved it a couple of days ago. #1923
Rebased again.

* Update gitignore * Resolve conflicts * Resolve conflicts

TheLarkInn · 2018-03-19T19:53:47Z

Did a branch sync also via UI.

TheLarkInn

I'm going to approve this. I feel pretty good about the state as is. Would someone be willing to open up.individual issues for things that look problematic from a content standpoint. Ideally we should get these surfaced to new contribs and more smaller PRs.

TheLarkInn · 2018-03-19T20:00:47Z

GitHub rate limit causing errors in CI.

dhruvdutt

LGTM except for minor improvements which could be dealt later. ⏳

webpack 4 🔥 🔥 🔥

Hypnosphi · 2018-03-19T22:50:06Z

src/content/api/plugins.md

@@ -39,7 +39,7 @@ noted.
 ## Plugin Types

 Depending on the hooks used and `tap` methods applied, plugins can function in
-a number of different ways. The way this works is closely related to the
+a different number of ways. The way this works is closely related to the


Is the change in meaning intended here?

I'm no native speaker, but looks like before it said "there are many ways, and it depends which way it will be actually", and now it's says "there may be many or not so many ways, it depends"

This is still evaluated the same.

FWIW I'm a non-native speaker as well and the previous version of this sentence sounded more understandable to me.

To me it sounds like the plugins, before, could work in various ways; but now it sounds like they work in a different amount of ways (???)

the previous sounds clearer to me.

montogeek · 2018-03-20T08:18:23Z

Finally 🎆

edmorley · 2018-03-22T14:05:14Z

This review comment still applies:
#1856 (comment)

TheLarkInn · 2018-03-22T19:56:42Z

@edmorley would you be willing to create a separate issue for this and tie it to this PR so we have visibility and linkage?

edmorley · 2018-03-23T17:52:37Z

Sure - filed #1947 :-)

MagicDuck and others added 24 commits February 6, 2018 23:19

adding docs for new output.devtoolNamespace option and [namespace] …

dafbbb2

…placeholder

adding extra lines as indicated

f3c515c

docs(config): update hashFunction docs based on v4 (#1761)

8ccb3da

docs(api): reformat index page at 80 characters / line

7fa4fe0

docs(api): reformat node api docs and add more details on the compiler

388aa68

This moves some of the content from `compiler.md` and brings it into the main node api documentation in order to allow `compiler.md` to become `compiler-hooks.md` which fits better in the context of plugins.

docs(api): remove module-factories.md and template.md

d5c0a24

These guides were full of todos and probably lead to more confusion than clarity. We can discuss more and add them back in once there's a clear flow for how to incorporate and document them.

docs(api): reformat line length in plugins.md

38e33c2

docs(api): rewrite, rename, and resort the compilation.md page

ede8e02

This page now uses the same section setup as `compiler-hooks.md` and is up to date with the latest hooks available in the webpack 4 alpha release.

docs(api): fix sorting and start to reformat the last two plugin pages

e0f7a62

docs(api): begin rewrite of the resolver page

ebe7331

docs(config): fix header nesting in resolve.md

b066b44

docs(api): rename resolvers page for clarity and finish rewrite

93efa5d

docs(api): make minor corrections to plugin docs

1555e7c

docs(api): rewrite the parser documentation

7941097

Improve lead-in to give a little more context on what the parser does. Add the latest hooks and use the same layout as the other pages in the section.

docs(api): update some of the compiler hook descriptions

acf7b77

docs(plugins): add ProfilingPlugin documentation (#1830)

7b89b9f

docs(config): document info-verbosity option in watch.md (#1817)

4354b9a

Merge branch 'master' into next

b1d2779

update tree shaking guide for webpack 4

6194853

docs(Guides): Update Getting Started to use webpack 4

6de8690

Updates the Get Started guide to use webpack 4 and adds some additional information about npm.

docs(concepts): Update plugins.md (#1871)

7d1f662

Update the plugins page in the concepts section to be compatible with webpack 4. Also adds a note about referencing the plugin name in camel-case when calling the `tap` method.

Merge branch 'master' into next

44eb6c9

skipjack added the New Release label Mar 3, 2018

skipjack mentioned this pull request Mar 3, 2018

docs(guide): The CLI moved into a separate package: webpack-cli #1877

Closed

osenvosem and others added 3 commits March 3, 2018 14:27

docs(Stats): add buitlAt to the example configuration (#1878)

45db042

This adds the `builtAt` option to the example configuration.

docs(guides): add doctype to Get Started (#1874)

a44fa0a

This adds valid doctypes to all the HTML examples in the Get Started guide.

docs(API): add missing config options to cli.md (#1880)

38faec2

This adds a table of config options for v4 to the API documentation.

quantizor added 3 commits March 15, 2018 01:58

update related links to be relevant for webpack 4

0e545a1

add note about side effects and non-JS files

9ad350d

add some more advanced usage notes

2f19976

dhruvdutt reviewed Mar 15, 2018

View reviewed changes

Merge pull request #1865 from probablyup/update-se-docs

c1318e1

update tree shaking guide for webpack 4

montogeek mentioned this pull request Mar 15, 2018

Includes installing webpack-cli #1913

Closed

dhruvdutt suggested changes Mar 15, 2018

View reviewed changes

montogeek and others added 2 commits March 15, 2018 23:06

docs(concepts) Clarification about NODE_ENV and mode (#1885)

051a566

chore(site): Delete package-lock.json (#1917)

e1029fc

* chore: clean package-lock.json * chore: sync yarn.lock

dhruvdutt mentioned this pull request Mar 17, 2018

Resolve conflicts on next branch #1923

Merged

docs(guides): Correct a path error in getting started example (#1899)

8b13724

* correct a path error in example

dhruvdutt and others added 2 commits March 19, 2018 19:51

chore: Resolve conflicts on next branch (#1923)

bec9d42

* Update gitignore * Resolve conflicts * Resolve conflicts

Merge branch 'master' into next

3197738

TheLarkInn approved these changes Mar 19, 2018

View reviewed changes

dhruvdutt approved these changes Mar 19, 2018

View reviewed changes

montogeek added 2 commits March 19, 2018 22:22

docs(api) Fix markdown lint errors

40d89f9

docs(api) Fix Plugins wording

74cb0e7

Hypnosphi reviewed Mar 19, 2018

View reviewed changes

TheLarkInn merged commit 6c2ab16 into master Mar 20, 2018

dhruvdutt mentioned this pull request Mar 21, 2018

[Dependency: Guides] - Add v4 Migration Guide #1934

Closed

4 tasks

edmorley mentioned this pull request Mar 23, 2018

Concepts - Mode: Add missing differences between production and development #1947

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Let's ship the webpack 4 documentation #1856

Let's ship the webpack 4 documentation #1856

sokra commented Feb 26, 2018

skipjack commented Mar 3, 2018

montogeek commented Mar 14, 2018 •

edited

Loading

dhruvdutt Mar 15, 2018

dhruvdutt Mar 15, 2018

dhruvdutt Mar 15, 2018 •

edited

Loading

dhruvdutt Mar 15, 2018 •

edited

Loading

dhruvdutt Mar 15, 2018

dhruvdutt Mar 15, 2018

montogeek Mar 15, 2018

dhruvdutt Mar 15, 2018 •

edited

Loading

dhruvdutt Mar 15, 2018

dhruvdutt left a comment •

edited

Loading

TheLarkInn commented Mar 19, 2018

dhruvdutt commented Mar 19, 2018

TheLarkInn commented Mar 19, 2018

TheLarkInn left a comment

TheLarkInn commented Mar 19, 2018

dhruvdutt left a comment •

edited

Loading

Hypnosphi Mar 19, 2018 •

edited

Loading

TheLarkInn Mar 20, 2018

mgol Mar 20, 2018

Jessidhia Mar 20, 2018

lifeiscontent Apr 5, 2018

montogeek commented Mar 20, 2018

edmorley commented Mar 22, 2018

TheLarkInn commented Mar 22, 2018

edmorley commented Mar 23, 2018

		@@ -144,20 +177,25 @@ In this setup, `index.js` explicitly requires `lodash` to be present, and binds
		With that said, let's run `npx webpack` with our script as the [entry point](/concepts/entry-points) and `bundle.js` as the [output](/concepts/output). The `npx` command, which ships with Node 8.2 or higher, runs the webpack binary (`./node_modules/.bin/webpack`) of the webpack package we installed in the beginning:

Let's ship the webpack 4 documentation #1856

Let's ship the webpack 4 documentation #1856

Conversation

sokra commented Feb 26, 2018

skipjack commented Mar 3, 2018

montogeek commented Mar 14, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dhruvdutt Mar 15, 2018 • edited Loading

Choose a reason for hiding this comment

dhruvdutt Mar 15, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dhruvdutt Mar 15, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dhruvdutt left a comment • edited Loading

Choose a reason for hiding this comment

TheLarkInn commented Mar 19, 2018

dhruvdutt commented Mar 19, 2018

TheLarkInn commented Mar 19, 2018

TheLarkInn left a comment

Choose a reason for hiding this comment

TheLarkInn commented Mar 19, 2018

dhruvdutt left a comment • edited Loading

Choose a reason for hiding this comment

Hypnosphi Mar 19, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

montogeek commented Mar 20, 2018

edmorley commented Mar 22, 2018

TheLarkInn commented Mar 22, 2018

edmorley commented Mar 23, 2018

montogeek commented Mar 14, 2018 •

edited

Loading

dhruvdutt Mar 15, 2018 •

edited

Loading

dhruvdutt Mar 15, 2018 •

edited

Loading

dhruvdutt Mar 15, 2018 •

edited

Loading

dhruvdutt left a comment •

edited

Loading

dhruvdutt left a comment •

edited

Loading

Hypnosphi Mar 19, 2018 •

edited

Loading