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

Guide - Get started #15

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

Guide - Get started #15

bebraw opened this issue Jun 29, 2016 · 7 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.


To quote @logaretm from #29:

Maybe it should cover:

  • What is Webpack? (in a small paragraph)
  • Establishing Mindset (JavaScript file as entry point) or how it works at its highest levels, some colleagues had issues understanding how it works since they were using gulp.
  • Files and Loaders (in two or three lines).

Then move on to a small example:

  • Installation.
  • Basic html page with an entry point, that just logs something or manipulates an element using jQuery.
  • Bundling the JS files.
  • Extracting chunks (like vendor) with CommonsChunk plugin.
  • Adding CSS (css loader and style loader).
  • Adding static resources like an image (file/url loader).
  • Optimization (Uglify, Clean).
  • HMR.

probably that would be somewhat enough to get used to most of Webpack concepts at a high level. I'm not sure if its too short or a bit long.

Probably some short version of this post.

@Awk34
Copy link

Awk34 commented Jun 30, 2016

Note: Apparently the 'What is webpack?' section of the current 'Getting Started' is confusing to many. Maybe it needs to be simplified even more from where it is now?

@bebraw
Copy link
Contributor Author

bebraw commented Jun 30, 2016

Yeah. That's a valid point.

I took a historical approach in my intro chapter to webpack. Maybe a similar idea would work here so you get the context before digging into webpack itself. If you don't understand the past, it's hard to appreciate the ideas.

@Awk34
Copy link

Awk34 commented Jun 30, 2016

@bebraw Nice article! I think that is spot on. Many people don't understand what Webpack is meant for.

@bebraw
Copy link
Contributor Author

bebraw commented Jun 30, 2016

I'm thinking a structure like this would work:

  1. Bit of history for context (adapt from above and link if someone wants to read more).
  2. Basic features of webpack. This would be a good place to link elsewhere in the documentation and show how the bits go together (loaders, plugins, entries, output) on a basic level.
  3. Brief comparison to show what tool to use and when. This shows webpack in context and highlights alternatives. For some usage a simpler tool like rollup could be completely enough. And this gives a better idea of how Grunt, Gulp, and such fit in.

Actually now that I think of it, we probably want a 5-10 minute intro to webpack. The current documentation has something. It would be a technical sibling to this first one and would show the basic concepts in practice.

@bebraw
Copy link
Contributor Author

bebraw commented Jul 2, 2016

FYI, I added a stub for 10 minute introduction.

@bebraw bebraw modified the milestone: Webpack 2 - Documentation MVP Jul 10, 2016
@bebraw bebraw changed the title Guide - Getting Started Guide - Get started Jul 24, 2016
@pksjce
Copy link

pksjce commented Oct 4, 2016

I would like to pick this up. Looks like its not been taken by anyone yet.

@bebraw
Copy link
Contributor Author

bebraw commented Oct 4, 2016

@pksjce Sure, do a quick draft at first of the planned structure so we can avoid a bit of effort. 👍

@bebraw bebraw closed this as completed in 0695f44 Oct 20, 2016
dear-lizhihua added a commit to docschina/webpack.js.org that referenced this issue Jan 8, 2017
fix: "webpack" should be lowercase
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

4 participants