Skip to content

How to - Develop #26

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

Closed
bebraw opened this issue Jun 29, 2016 · 9 comments
Closed

How to - Develop #26

bebraw opened this issue Jun 29, 2016 · 9 comments

Comments

@bebraw
Copy link
Contributor

bebraw commented Jun 29, 2016

Stub.

Feel free to comment here if you have ideas on what this guide should cover. Link to potential resources too.

@bebraw bebraw modified the milestone: Webpack 2 - Documentation MVP Jul 10, 2016
@mxstbr
Copy link
Collaborator

mxstbr commented Jul 10, 2016

TL;DR of contents:

The webpack-dev-server allows users to run a web-server from the command line that's enhanced with some webpack-specific events which enable certain features like hot-module-reloading.

The watch mode, as the name suggest, watches your filesystem for changes in the files that webpack cares about in its bundle. If a file is changed, webpack automatically rebuilds the bundle and sends it to the client via the dev server.


Should we also touch on HMR in this section possibly?

@bebraw
Copy link
Contributor Author

bebraw commented Jul 10, 2016

I ended up stubbing how to develop? kind of article at my Antwar based prototype. It would cover --watch, HMR, webpack-dev-server.

I actually have a related chapter here.

If we can keep the site pages simple and link to external resources at the end, that would get us pretty far I think.

@mxstbr
Copy link
Collaborator

mxstbr commented Jul 10, 2016

Yeah that sounds very reasonable

@e-cloud
Copy link

e-cloud commented Jul 11, 2016

Including the documentation about the API of webpack-dev-server would be better.

@bebraw bebraw changed the title Usage - Using Watch and Dev Server How to - Develop Jul 24, 2016
@bebraw bebraw added the Guides label Jul 24, 2016
@SpaceK33z
Copy link
Member

SpaceK33z commented Aug 23, 2016

I'm helping maintaining WDS, and looking through the issues, these occur the most:

  • Using it with Docker.
  • Using it with a proxy, and after they get that working, CORS.
  • Getting it to work with vagrant (need to use --watch-poll, and a custom 'public' url).
  • Wanting to use [hash] in file, which causes a memory leak and many other weird issues (make clear that cache busting is not necessary for dev!).

I'll try to write some documentation soon (1-2 weeks) on this part.

@bebraw
Copy link
Contributor Author

bebraw commented Aug 23, 2016

@SpaceK33z There's a separate issue related to Docker (#44). I expect similar articles for the rest (proxying, Vagrant) would work too. Small, focused "how tos" would be great.

@SpaceK33z
Copy link
Member

So in #78 I've written some documentation on how to use it with Vagrant.

I noticed that the current documentation of WDS is not yet ported. Is this something I could work on? If yes, where would this documentation live? Maybe in api/dev-server-cli.md, api/dev-server-node.md and put the examples etc. in how-to/develop.md?

@bebraw
Copy link
Contributor Author

bebraw commented Aug 28, 2016

I noticed that the current documentation of WDS is not yet ported. Is this something I could work on? If yes, where would this documentation live? Maybe in api/dev-server-cli.md, api/dev-server-node.md and put the examples etc. in how-to/develop.md?

Yeah, that would be great. The suggested articles would work well.

@SpaceK33z
Copy link
Member

I'm currently working on this, if anybody wants to help, please discuss first to prevent duplicate work.

@SpaceK33z SpaceK33z self-assigned this Oct 3, 2016
@bebraw bebraw closed this as completed in f8fedc2 Oct 11, 2016
sallar pushed a commit to sallar/webpack.js.org that referenced this issue Oct 19, 2016
hzuhyb pushed a commit to hzuhyb/webpack.js.org that referenced this issue Jan 24, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants