docs: improve http2 example (#3832)

webpack · Sep 11, 2021 · f812e01 · f812e01
1 parent 2b1208d
commit f812e01
Show file tree

Hide file tree

Showing 10 changed files with 52 additions and 23 deletions.
diff --git a/examples/http2/boolean/README.md b/examples/http2/boolean/README.md
@@ -0,0 +1,25 @@
+# http2 option
+
+Serve over HTTP/2 using [spdy](https://www.npmjs.com/package/spdy). This option is ignored for Node 15.0.0 and above, as `spdy` is broken for those versions.
+
+## HTTP/2 with a self-signed certificate:
+
+```js
+module.exports = {
+  // ...
+  devServer: {
+    http2: true,
+  },
+};
+```
+
+Usage via CLI:
+
+```console
+npx webpack serve --open --http2
+```
+
+### What Should Happen
+
+1. The script should open `https://localhost:8080/` in your default browser.
+2. You should see the text on the page itself change to read `Success!`.
diff --git a/examples/http2/app.js → examples/http2/boolean/app.js b/examples/http2/app.js → examples/http2/boolean/app.js
diff --git a/examples/http2/webpack.config.js → examples/http2/boolean/webpack.config.js b/examples/http2/webpack.config.js → examples/http2/boolean/webpack.config.js
@@ -2,7 +2,7 @@
 
 // our setup function adds behind-the-scenes bits to the config that all of our
 // examples need
-const { setup } = require("../util");
+const { setup } = require("../../util");
 
 module.exports = setup({
   context: __dirname,

diff --git a/examples/http2/README.md → .../http2/with-https-configuration/README.md b/examples/http2/README.md → .../http2/with-https-configuration/README.md
@@ -2,28 +2,6 @@
 
 Serve over HTTP/2 using [spdy](https://www.npmjs.com/package/spdy). This option is ignored for Node 15.0.0 and above, as `spdy` is broken for those versions.
 
-## HTTP/2 with a self-signed certificate:
-
-```js
-module.exports = {
-  // ...
-  devServer: {
-    http2: true,
-  },
-};
-```
-
-Usage via CLI:
-
-```console
-npx webpack serve --open --http2
-```
-
-### What Should Happen
-
-1. The script should open `https://localhost:8080/` in your default browser.
-2. You should see the text on the page itself change to read `Success!`.
-
 ## HTTP/2 with a custom certificate:
 
 Provide your own certificate using the [https](https://webpack.js.org/configuration/dev-server/#devserverhttps) option:

diff --git a/examples/http2/with-https-configuration/app.js b/examples/http2/with-https-configuration/app.js
@@ -0,0 +1,6 @@
+"use strict";
+
+const target = document.querySelector("#target");
+
+target.classList.add("pass");
+target.innerHTML = "Success!";
diff --git a/examples/http2/ssl/ca.pem → ...http2/with-https-configuration/ssl/ca.pem b/examples/http2/ssl/ca.pem → ...http2/with-https-configuration/ssl/ca.pem
diff --git a/examples/http2/ssl/server.crt → ...2/with-https-configuration/ssl/server.crt b/examples/http2/ssl/server.crt → ...2/with-https-configuration/ssl/server.crt
diff --git a/examples/http2/ssl/server.key → ...2/with-https-configuration/ssl/server.key b/examples/http2/ssl/server.key → ...2/with-https-configuration/ssl/server.key
diff --git a/examples/http2/ssl/server.pfx → ...2/with-https-configuration/ssl/server.pfx b/examples/http2/ssl/server.pfx → ...2/with-https-configuration/ssl/server.pfx
diff --git a/examples/http2/with-https-configuration/webpack.config.js b/examples/http2/with-https-configuration/webpack.config.js
@@ -0,0 +1,20 @@
+"use strict";
+
+// our setup function adds behind-the-scenes bits to the config that all of our
+// examples need
+const { setup } = require("../../util");
+
+module.exports = setup({
+  context: __dirname,
+  entry: "./app.js",
+  devServer: {
+    http2: true,
+    https: {
+      key: "./ssl/server.key",
+      pfx: "./ssl/server.pfx",
+      cert: "./ssl/server.crt",
+      ca: "./ssl/ca.pem",
+      passphrase: "webpack-dev-server",
+    },
+  },
+});