Update docs with troubleshooting information: watching section #1779

EugeneHlushko · 2018-01-10T09:38:39Z

After accidentally getting onto @sokra and @gaearon discussion of old docs missing page on twitter, i decided to send a PR with troubleshooting section for webpack watch. This makes it easier to find and to make people link to our docs website instead of old wiki page.

ChrisChinchilla · 2018-01-16T08:17:20Z

src/content/configuration/watch.md

+
+## Webpack doesn't recompile on change while watching
+
+### File changes are being seen, just no files are being updated


@EugeneHlushko

File changes are seen, but no files are updated

ChrisChinchilla · 2018-01-16T08:18:03Z

src/content/configuration/watch.md

+
+### File changes are being seen, just no files are being updated
+
+Verify that webpack is not being notified of changes by running with the --progress flag. If progress shows on save but no files are output, it is likely a configuration issue, not a file watching issue.


@EugeneHlushko

I would suggest a small grammar and formatting tweak…

running webpack with the --progress flag

ChrisChinchilla · 2018-01-16T08:18:31Z

src/content/configuration/watch.md

+
+### File changes are being seen, just no files are being updated
+
+Verify that webpack is not being notified of changes by running with the --progress flag. If progress shows on save but no files are output, it is likely a configuration issue, not a file watching issue.


@EugeneHlushko

no files are outputted

ChrisChinchilla · 2018-01-16T08:19:16Z

src/content/configuration/watch.md

+cat /proc/sys/fs/inotify/max_user_watches
+```
+
+Arch users, add `fs.inotify.max_user_watches=524288` to `/etc/sysctl.d/99-sysctl.conf` and then execute `sysctl --system`. Ubuntu users (and possibly others): `echo fs.inotify.max_user_watches=524288 | sudo tee -a /etc/sysctl.conf && sudo sysctl -p`.


@EugeneHlushko

For consistency…

Ubuntu users (and possibly others), execute

ChrisChinchilla · 2018-01-16T08:19:54Z

src/content/configuration/watch.md

+### macOS fsevents bug
+
+On macOS folders can get corrupted. See this article:
+


@EugeneHlushko You can probably just combine the 'See this article' text with the link for the article.

ChrisChinchilla · 2018-01-16T08:24:10Z

src/content/configuration/watch.md

+
+### Windows paths
+
+webpack expects absolute paths for many config options. `__dirname + "/app/folder"` is wrong, because windows uses `\` as path separator. This breaks some stuff.


@EugeneHlushko How about…

Because webpack expects absolute paths for many config options such as __dirname + "/app/folder" the Windows \ path separator can break some functionality.

ChrisChinchilla · 2018-01-16T08:24:42Z

src/content/configuration/watch.md

+
+### Vim
+
+On some machines Vim is preconfigured with the [backupcopy option](http://vimdoc.sourceforge.net/htmldoc/options.html#'backupcopy') set to **auto**. This could potentially cause problems with the system's file watching mechanism. Switching this option to `yes` will make sure a copy of the file is made and the original one overwritten on save. 


@EugeneHlushko Personally I think auto should be auto as it's config.

ChrisChinchilla

Thanks for your submission @EugeneHlushko I have a few small suggestions…

EugeneHlushko · 2018-01-16T09:35:22Z

Thanks @ChrisChinchilla all seems legit, i will update PR today

EugeneHlushko · 2018-01-16T12:46:43Z

@ChrisChinchilla its updated now, pls take a look

ChrisChinchilla · 2018-01-17T11:06:25Z

@EugeneHlushko Looks good, thanks!

skipjack

Thanks for this addition @EugeneHlushko. I think the content is great and the grammar seems fine, my only issue is the header structure. See my comments for more info and let me know if I can clarify anything.

skipjack · 2018-01-24T04:55:51Z

src/content/configuration/watch.md

@@ -70,3 +70,44 @@ poll: 1000 // Check for changes every second

 T> If watching does not work for you, try out this option. Watching does not work with NFS and machines in VirtualBox.

+# Troubleshooting


We shouldn't have two h1s on the page. Can you switch this to a ## and add an extra line break before it (we typically use two before ## headers).

skipjack · 2018-01-24T05:07:38Z

src/content/configuration/watch.md

@@ -70,3 +70,44 @@ poll: 1000 // Check for changes every second

 T> If watching does not work for you, try out this option. Watching does not work with NFS and machines in VirtualBox.

+# Troubleshooting
+
+## Webpack doesn't recompile on change while watching


I would rather see more concise titles here as very long ones won't be very intuitive or easy to display in our side nav, e.g.:

For example, maybe the following would work better and still convey the idea:

### Missed Compilations

Please consider the same change for the rest of the longer headers. Also note that I changed this to an h3 to properly nest it under:

## Troubleshooting

Another option would be to simply change them from headers to bold text, for example:

Troubleshooting

If you are experiencing any issues, please see the following notes. There are a variety of reasons why
webpack might miss a file change.

Changes are seen, but no files are updated

...

Not enough watchers

...

EugeneHlushko · 2018-01-26T15:30:24Z

Hi @skipjack
Thank you for review 👍
Have updated the branch as it got outdated and moved headers one level down. I didn't go down to h4... or should i as Missed Compilations is h3 already?

EugeneHlushko · 2018-01-28T12:18:35Z

Hi @skipjack
Any chance to look at this soon?

skipjack · 2018-01-29T02:47:51Z

Have updated the branch as it got outdated and moved headers one level down. I didn't go down to h4... or should i as Missed Compilations is h3 already?

See the end of my comment from before (quoted below), personally I think you should update it like so (and drop Missed Compilations as that's the only Troubleshooting subsection):

Troubleshooting

If you are experiencing any issues, please see the following notes. There are a variety of reasons why webpack might miss a file change.

Changes are seen, but no files are updated

...

Not enough watchers

...

This approach means you don't have to shorten each subsection title but we won't have the run-on title issue in the sidebar.

…ding

EugeneHlushko · 2018-01-29T12:50:38Z

Thank you for clarification @skipjack ! 👍
I've removed it looks good now, please confirm

skipjack added Enhancement Configuration labels Jan 14, 2018

ChrisChinchilla reviewed Jan 16, 2018

View reviewed changes

ChrisChinchilla requested changes Jan 16, 2018

View reviewed changes

EugeneHlushko force-pushed the update/watching-troubleshooting branch from 6234a2f to b7fc618 Compare January 16, 2018 12:45

ChrisChinchilla approved these changes Jan 17, 2018

View reviewed changes

skipjack requested changes Jan 24, 2018

View reviewed changes

EugeneHlushko added 2 commits January 26, 2018 22:23

Update docs with troubleshooting information: watching section

98cbc16

Update docs with troubleshooting information: Peer Review updates

701a8a4

EugeneHlushko force-pushed the update/watching-troubleshooting branch from 432dfbc to 701a8a4 Compare January 26, 2018 15:27

Update docs with troubleshooting information: more formatting

7ca6bf1

Update docs with troubleshooting information: Remove redundant subhea…

4d3f77c

…ding

docs(config): tighten troubleshooting titles and add lead-in

59f873f

skipjack approved these changes Jan 30, 2018

View reviewed changes

skipjack merged commit 8e604cc into webpack:master Jan 30, 2018


		## Webpack doesn't recompile on change while watching

		### File changes are being seen, just no files are being updated


		### File changes are being seen, just no files are being updated

		Verify that webpack is not being notified of changes by running with the --progress flag. If progress shows on save but no files are output, it is likely a configuration issue, not a file watching issue.

		### macOS fsevents bug

		On macOS folders can get corrupted. See this article:


		### Windows paths

		webpack expects absolute paths for many config options. `__dirname + "/app/folder"` is wrong, because windows uses `\` as path separator. This breaks some stuff.


		### Vim

		On some machines Vim is preconfigured with the [backupcopy option](http://vimdoc.sourceforge.net/htmldoc/options.html#'backupcopy') set to auto. This could potentially cause problems with the system's file watching mechanism. Switching this option to `yes` will make sure a copy of the file is made and the original one overwritten on save.

		@@ -70,3 +70,44 @@ poll: 1000 // Check for changes every second

		T> If watching does not work for you, try out this option. Watching does not work with NFS and machines in VirtualBox.

		# Troubleshooting

Uh oh!

Update docs with troubleshooting information: watching section #1779

Update docs with troubleshooting information: watching section #1779

Uh oh!

Conversation

EugeneHlushko commented Jan 10, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ChrisChinchilla left a comment

Choose a reason for hiding this comment

Uh oh!

EugeneHlushko commented Jan 16, 2018

Uh oh!

EugeneHlushko commented Jan 16, 2018

Uh oh!

ChrisChinchilla commented Jan 17, 2018

Uh oh!

skipjack left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Troubleshooting

Uh oh!

EugeneHlushko commented Jan 26, 2018

Uh oh!

EugeneHlushko commented Jan 28, 2018

Uh oh!

skipjack commented Jan 29, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Troubleshooting

Uh oh!

EugeneHlushko commented Jan 29, 2018

Uh oh!

Uh oh!

EugeneHlushko commented Jan 10, 2018 •

edited

Loading

skipjack commented Jan 29, 2018 •

edited

Loading