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.

Sign up for GitHub

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

Jump to bottom

Simplify example usage instructions #16678

Merged
merged 8 commits into from
Aug 30, 2020
Merged

Simplify example usage instructions #16678

merged 8 commits into from
Aug 30, 2020

Conversation

NorbertLuszkiewicz
Copy link
Contributor

@NorbertLuszkiewicz NorbertLuszkiewicz commented Aug 29, 2020 •
edited by Timer
Loading

Remove the manual download option

Fixes #16656

@ijjk ijjk added the examples Issue was opened via the examples template. label Aug 29, 2020
@ijjk
Copy link
Member

ijjk commented Aug 29, 2020

Stats from current PR

Default Server Mode (Increase detected ⚠️)
General
vercel/next.js canary NorbertLuszkiewicz/next.js canary Change
buildDuration 12.6s 12.6s ⚠️ +32ms
nodeModulesSize 57.5 MB 57.5 MB ✓
Page Load Tests Overall increase ✓
vercel/next.js canary NorbertLuszkiewicz/next.js canary Change
/ failed reqs 0 0 ✓
/ total time (seconds) 2.256 2.195 -0.06
/ avg req/sec 1108.4 1139.03 +30.63
/error-in-render failed reqs 0 0 ✓
/error-in-render total time (seconds) 1.299 1.264 -0.03
/error-in-render avg req/sec 1924.11 1978.14 +54.03
Client Bundles (main, webpack, commons)
vercel/next.js canary NorbertLuszkiewicz/next.js canary Change
677f882d2ed8..f20b.js gzip 10.3 kB 10.3 kB ✓
framework.HASH.js gzip 39 kB 39 kB ✓
main-ce79c9a..12c9.js gzip 7.36 kB 7.36 kB ✓
webpack-e067..f178.js gzip 751 B 751 B ✓
Overall change 57.3 kB 57.3 kB ✓
Client Bundles (main, webpack, commons) Modern
vercel/next.js canary NorbertLuszkiewicz/next.js canary Change
677f882d2ed8..dule.js gzip 6.13 kB 6.13 kB ✓
framework.HA..dule.js gzip 39 kB 39 kB ✓
main-9973c26..dule.js gzip 6.42 kB 6.42 kB ✓
webpack-07c5..dule.js gzip 751 B 751 B ✓
Overall change 52.3 kB 52.3 kB ✓
Legacy Client Bundles (polyfills)
vercel/next.js canary NorbertLuszkiewicz/next.js canary Change
polyfills-4b..e242.js gzip 31 kB 31 kB ✓
Overall change 31 kB 31 kB ✓
Client Pages
vercel/next.js canary NorbertLuszkiewicz/next.js canary Change
_app-9a0b9e1..b37e.js gzip 1.28 kB 1.28 kB ✓
_error-28298..e0c9.js gzip 3.44 kB 3.44 kB ✓
hooks-89731c..c609.js gzip 887 B 887 B ✓
index-17468f..5d83.js gzip 227 B 227 B ✓
link-000f151..65d4.js gzip 1.29 kB 1.29 kB ✓
routerDirect..924c.js gzip 284 B 284 B ✓
withRouter-7..c13d.js gzip 284 B 284 B ✓
Overall change 7.69 kB 7.69 kB ✓
Client Pages Modern
vercel/next.js canary NorbertLuszkiewicz/next.js canary Change
_app-75d3a82..dule.js gzip 625 B 625 B ✓
_error-65c8a..dule.js gzip 2.29 kB 2.29 kB ✓
hooks-cbf13f..dule.js gzip 387 B 387 B ✓
index-b9a643..dule.js gzip 226 B 226 B ✓
link-4cfda7a..dule.js gzip 1.26 kB 1.26 kB ✓
routerDirect..dule.js gzip 284 B 284 B ✓
withRouter-f..dule.js gzip 282 B 282 B ✓
Overall change 5.35 kB 5.35 kB ✓
Client Build Manifests
vercel/next.js canary NorbertLuszkiewicz/next.js canary Change
_buildManifest.js gzip 322 B 322 B ✓
_buildManife..dule.js gzip 330 B 330 B ✓
Overall change 652 B 652 B ✓
Rendered Page Sizes
vercel/next.js canary NorbertLuszkiewicz/next.js canary Change
index.html gzip 972 B 972 B ✓
link.html gzip 978 B 978 B ✓
withRouter.html gzip 964 B 964 B ✓
Overall change 2.91 kB 2.91 kB ✓
Serverless Mode
General
vercel/next.js canary NorbertLuszkiewicz/next.js canary Change
buildDuration 13.9s 14.1s ⚠️ +199ms
nodeModulesSize 57.5 MB 57.5 MB ✓
Client Bundles (main, webpack, commons)
vercel/next.js canary NorbertLuszkiewicz/next.js canary Change
677f882d2ed8..f20b.js gzip 10.3 kB 10.3 kB ✓
framework.HASH.js gzip 39 kB 39 kB ✓
main-ce79c9a..12c9.js gzip 7.36 kB 7.36 kB ✓
webpack-e067..f178.js gzip 751 B 751 B ✓
Overall change 57.3 kB 57.3 kB ✓
Client Bundles (main, webpack, commons) Modern
vercel/next.js canary NorbertLuszkiewicz/next.js canary Change
677f882d2ed8..dule.js gzip 6.13 kB 6.13 kB ✓
framework.HA..dule.js gzip 39 kB 39 kB ✓
main-9973c26..dule.js gzip 6.42 kB 6.42 kB ✓
webpack-07c5..dule.js gzip 751 B 751 B ✓
Overall change 52.3 kB 52.3 kB ✓
Legacy Client Bundles (polyfills)
vercel/next.js canary NorbertLuszkiewicz/next.js canary Change
polyfills-4b..e242.js gzip 31 kB 31 kB ✓
Overall change 31 kB 31 kB ✓
Client Pages
vercel/next.js canary NorbertLuszkiewicz/next.js canary Change
_app-9a0b9e1..b37e.js gzip 1.28 kB 1.28 kB ✓
_error-28298..e0c9.js gzip 3.44 kB 3.44 kB ✓
hooks-89731c..c609.js gzip 887 B 887 B ✓
index-17468f..5d83.js gzip 227 B 227 B ✓
link-000f151..65d4.js gzip 1.29 kB 1.29 kB ✓
routerDirect..924c.js gzip 284 B 284 B ✓
withRouter-7..c13d.js gzip 284 B 284 B ✓
Overall change 7.69 kB 7.69 kB ✓
Client Pages Modern
vercel/next.js canary NorbertLuszkiewicz/next.js canary Change
_app-75d3a82..dule.js gzip 625 B 625 B ✓
_error-65c8a..dule.js gzip 2.29 kB 2.29 kB ✓
hooks-cbf13f..dule.js gzip 387 B 387 B ✓
index-b9a643..dule.js gzip 226 B 226 B ✓
link-4cfda7a..dule.js gzip 1.26 kB 1.26 kB ✓
routerDirect..dule.js gzip 284 B 284 B ✓
withRouter-f..dule.js gzip 282 B 282 B ✓
Overall change 5.35 kB 5.35 kB ✓
Client Build Manifests
vercel/next.js canary NorbertLuszkiewicz/next.js canary Change
_buildManifest.js gzip 322 B 322 B ✓
_buildManife..dule.js gzip 330 B 330 B ✓
Overall change 652 B 652 B ✓
Serverless bundles
vercel/next.js canary NorbertLuszkiewicz/next.js canary Change
_error.js 1.03 MB 1.03 MB ✓
404.html 4.22 kB 4.22 kB ✓
hooks.html 3.86 kB 3.86 kB ✓
index.js 1.03 MB 1.03 MB ✓
link.js 1.07 MB 1.07 MB ✓
routerDirect.js 1.07 MB 1.07 MB ✓
withRouter.js 1.07 MB 1.07 MB ✓
Overall change 5.28 MB 5.28 MB ✓
Commit: da0484f

@Timer Timer changed the title Update README.mb Simplify example usage instructions Aug 30, 2020
Timer
Timer approved these changes Aug 30, 2020
View reviewed changes
Copy link
Member

@Timer Timer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks!

@ijjk
Copy link
Member

ijjk commented Aug 30, 2020

Stats from current PR

Default Server Mode (Decrease detected ✓)
General
vercel/next.js canary NorbertLuszkiewicz/next.js canary Change
buildDuration 13.9s 13.6s -253ms
nodeModulesSize 57.4 MB 57.4 MB ✓
Page Load Tests Overall decrease ⚠️
vercel/next.js canary NorbertLuszkiewicz/next.js canary Change
/ failed reqs 0 0 ✓
/ total time (seconds) 2.608 2.626 ⚠️ +0.02
/ avg req/sec 958.72 951.91 ⚠️ -6.81
/error-in-render failed reqs 0 0 ✓
/error-in-render total time (seconds) 1.518 1.677 ⚠️ +0.16
/error-in-render avg req/sec 1646.64 1491.2 ⚠️ -155.44
Client Bundles (main, webpack, commons)
vercel/next.js canary NorbertLuszkiewicz/next.js canary Change
677f882d2ed8..f20b.js gzip 10.3 kB 10.3 kB ✓
framework.HASH.js gzip 39 kB 39 kB ✓
main-ce79c9a..12c9.js gzip 7.36 kB 7.36 kB ✓
webpack-e067..f178.js gzip 751 B 751 B ✓
Overall change 57.3 kB 57.3 kB ✓
Client Bundles (main, webpack, commons) Modern
vercel/next.js canary NorbertLuszkiewicz/next.js canary Change
677f882d2ed8..dule.js gzip 6.13 kB 6.13 kB ✓
framework.HA..dule.js gzip 39 kB 39 kB ✓
main-9973c26..dule.js gzip 6.42 kB 6.42 kB ✓
webpack-07c5..dule.js gzip 751 B 751 B ✓
Overall change 52.3 kB 52.3 kB ✓
Legacy Client Bundles (polyfills)
vercel/next.js canary NorbertLuszkiewicz/next.js canary Change
polyfills-4b..e242.js gzip 31 kB 31 kB ✓
Overall change 31 kB 31 kB ✓
Client Pages
vercel/next.js canary NorbertLuszkiewicz/next.js canary Change
_app-9a0b9e1..b37e.js gzip 1.28 kB 1.28 kB ✓
_error-28298..e0c9.js gzip 3.44 kB 3.44 kB ✓
hooks-89731c..c609.js gzip 887 B 887 B ✓
index-17468f..5d83.js gzip 227 B 227 B ✓
link-000f151..65d4.js gzip 1.29 kB 1.29 kB ✓
routerDirect..924c.js gzip 284 B 284 B ✓
withRouter-7..c13d.js gzip 284 B 284 B ✓
Overall change 7.69 kB 7.69 kB ✓
Client Pages Modern
vercel/next.js canary NorbertLuszkiewicz/next.js canary Change
_app-75d3a82..dule.js gzip 625 B 625 B ✓
_error-65c8a..dule.js gzip 2.29 kB 2.29 kB ✓
hooks-cbf13f..dule.js gzip 387 B 387 B ✓
index-b9a643..dule.js gzip 226 B 226 B ✓
link-4cfda7a..dule.js gzip 1.26 kB 1.26 kB ✓
routerDirect..dule.js gzip 284 B 284 B ✓
withRouter-f..dule.js gzip 282 B 282 B ✓
Overall change 5.35 kB 5.35 kB ✓
Client Build Manifests
vercel/next.js canary NorbertLuszkiewicz/next.js canary Change
_buildManifest.js gzip 322 B 322 B ✓
_buildManife..dule.js gzip 330 B 330 B ✓
Overall change 652 B 652 B ✓
Rendered Page Sizes
vercel/next.js canary NorbertLuszkiewicz/next.js canary Change
index.html gzip 972 B 972 B ✓
link.html gzip 978 B 978 B ✓
withRouter.html gzip 964 B 964 B ✓
Overall change 2.91 kB 2.91 kB ✓
Serverless Mode
General
vercel/next.js canary NorbertLuszkiewicz/next.js canary Change
buildDuration 15.7s 15.7s -35ms
nodeModulesSize 57.4 MB 57.4 MB ✓
Client Bundles (main, webpack, commons)
vercel/next.js canary NorbertLuszkiewicz/next.js canary Change
677f882d2ed8..f20b.js gzip 10.3 kB 10.3 kB ✓
framework.HASH.js gzip 39 kB 39 kB ✓
main-ce79c9a..12c9.js gzip 7.36 kB 7.36 kB ✓
webpack-e067..f178.js gzip 751 B 751 B ✓
Overall change 57.3 kB 57.3 kB ✓
Client Bundles (main, webpack, commons) Modern
vercel/next.js canary NorbertLuszkiewicz/next.js canary Change
677f882d2ed8..dule.js gzip 6.13 kB 6.13 kB ✓
framework.HA..dule.js gzip 39 kB 39 kB ✓
main-9973c26..dule.js gzip 6.42 kB 6.42 kB ✓
webpack-07c5..dule.js gzip 751 B 751 B ✓
Overall change 52.3 kB 52.3 kB ✓
Legacy Client Bundles (polyfills)
vercel/next.js canary NorbertLuszkiewicz/next.js canary Change
polyfills-4b..e242.js gzip 31 kB 31 kB ✓
Overall change 31 kB 31 kB ✓
Client Pages
vercel/next.js canary NorbertLuszkiewicz/next.js canary Change
_app-9a0b9e1..b37e.js gzip 1.28 kB 1.28 kB ✓
_error-28298..e0c9.js gzip 3.44 kB 3.44 kB ✓
hooks-89731c..c609.js gzip 887 B 887 B ✓
index-17468f..5d83.js gzip 227 B 227 B ✓
link-000f151..65d4.js gzip 1.29 kB 1.29 kB ✓
routerDirect..924c.js gzip 284 B 284 B ✓
withRouter-7..c13d.js gzip 284 B 284 B ✓
Overall change 7.69 kB 7.69 kB ✓
Client Pages Modern
vercel/next.js canary NorbertLuszkiewicz/next.js canary Change
_app-75d3a82..dule.js gzip 625 B 625 B ✓
_error-65c8a..dule.js gzip 2.29 kB 2.29 kB ✓
hooks-cbf13f..dule.js gzip 387 B 387 B ✓
index-b9a643..dule.js gzip 226 B 226 B ✓
link-4cfda7a..dule.js gzip 1.26 kB 1.26 kB ✓
routerDirect..dule.js gzip 284 B 284 B ✓
withRouter-f..dule.js gzip 282 B 282 B ✓
Overall change 5.35 kB 5.35 kB ✓
Client Build Manifests
vercel/next.js canary NorbertLuszkiewicz/next.js canary Change
_buildManifest.js gzip 322 B 322 B ✓
_buildManife..dule.js gzip 330 B 330 B ✓
Overall change 652 B 652 B ✓
Serverless bundles
vercel/next.js canary NorbertLuszkiewicz/next.js canary Change
_error.js 1.03 MB 1.03 MB ✓
404.html 4.22 kB 4.22 kB ✓
hooks.html 3.86 kB 3.86 kB ✓
index.js 1.03 MB 1.03 MB ✓
link.js 1.07 MB 1.07 MB ✓
routerDirect.js 1.07 MB 1.07 MB ✓
withRouter.js 1.07 MB 1.07 MB ✓
Overall change 5.28 MB 5.28 MB ✓
Commit: b28f88e

@ijjk
Copy link
Member

ijjk commented Aug 30, 2020

Stats from current PR

Default Server Mode (Decrease detected ✓)
General
vercel/next.js canary NorbertLuszkiewicz/next.js canary Change
buildDuration 14.5s 14.7s ⚠️ +174ms
nodeModulesSize 57.4 MB 57.4 MB ✓
Page Load Tests Overall decrease ⚠️
vercel/next.js canary NorbertLuszkiewicz/next.js canary Change
/ failed reqs 0 0 ✓
/ total time (seconds) 2.696 2.727 ⚠️ +0.03
/ avg req/sec 927.24 916.61 ⚠️ -10.63
/error-in-render failed reqs 0 0 ✓
/error-in-render total time (seconds) 1.661 1.692 ⚠️ +0.03
/error-in-render avg req/sec 1505.46 1477.49 ⚠️ -27.97
Client Bundles (main, webpack, commons)
vercel/next.js canary NorbertLuszkiewicz/next.js canary Change
677f882d2ed8..f20b.js gzip 10.3 kB 10.3 kB ✓
framework.HASH.js gzip 39 kB 39 kB ✓
main-ce79c9a..12c9.js gzip 7.36 kB 7.36 kB ✓
webpack-e067..f178.js gzip 751 B 751 B ✓
Overall change 57.3 kB 57.3 kB ✓
Client Bundles (main, webpack, commons) Modern
vercel/next.js canary NorbertLuszkiewicz/next.js canary Change
677f882d2ed8..dule.js gzip 6.13 kB 6.13 kB ✓
framework.HA..dule.js gzip 39 kB 39 kB ✓
main-9973c26..dule.js gzip 6.42 kB 6.42 kB ✓
webpack-07c5..dule.js gzip 751 B 751 B ✓
Overall change 52.3 kB 52.3 kB ✓
Legacy Client Bundles (polyfills)
vercel/next.js canary NorbertLuszkiewicz/next.js canary Change
polyfills-4b..e242.js gzip 31 kB 31 kB ✓
Overall change 31 kB 31 kB ✓
Client Pages
vercel/next.js canary NorbertLuszkiewicz/next.js canary Change
_app-9a0b9e1..b37e.js gzip 1.28 kB 1.28 kB ✓
_error-28298..e0c9.js gzip 3.44 kB 3.44 kB ✓
hooks-89731c..c609.js gzip 887 B 887 B ✓
index-17468f..5d83.js gzip 227 B 227 B ✓
link-000f151..65d4.js gzip 1.29 kB 1.29 kB ✓
routerDirect..924c.js gzip 284 B 284 B ✓
withRouter-7..c13d.js gzip 284 B 284 B ✓
Overall change 7.69 kB 7.69 kB ✓
Client Pages Modern
vercel/next.js canary NorbertLuszkiewicz/next.js canary Change
_app-75d3a82..dule.js gzip 625 B 625 B ✓
_error-65c8a..dule.js gzip 2.29 kB 2.29 kB ✓
hooks-cbf13f..dule.js gzip 387 B 387 B ✓
index-b9a643..dule.js gzip 226 B 226 B ✓
link-4cfda7a..dule.js gzip 1.26 kB 1.26 kB ✓
routerDirect..dule.js gzip 284 B 284 B ✓
withRouter-f..dule.js gzip 282 B 282 B ✓
Overall change 5.35 kB 5.35 kB ✓
Client Build Manifests
vercel/next.js canary NorbertLuszkiewicz/next.js canary Change
_buildManifest.js gzip 322 B 322 B ✓
_buildManife..dule.js gzip 330 B 330 B ✓
Overall change 652 B 652 B ✓
Rendered Page Sizes
vercel/next.js canary NorbertLuszkiewicz/next.js canary Change
index.html gzip 972 B 972 B ✓
link.html gzip 978 B 978 B ✓
withRouter.html gzip 964 B 964 B ✓
Overall change 2.91 kB 2.91 kB ✓
Serverless Mode
General
vercel/next.js canary NorbertLuszkiewicz/next.js canary Change
buildDuration 16.5s 16.3s -221ms
nodeModulesSize 57.4 MB 57.4 MB ✓
Client Bundles (main, webpack, commons)
vercel/next.js canary NorbertLuszkiewicz/next.js canary Change
677f882d2ed8..f20b.js gzip 10.3 kB 10.3 kB ✓
framework.HASH.js gzip 39 kB 39 kB ✓
main-ce79c9a..12c9.js gzip 7.36 kB 7.36 kB ✓
webpack-e067..f178.js gzip 751 B 751 B ✓
Overall change 57.3 kB 57.3 kB ✓
Client Bundles (main, webpack, commons) Modern
vercel/next.js canary NorbertLuszkiewicz/next.js canary Change
677f882d2ed8..dule.js gzip 6.13 kB 6.13 kB ✓
framework.HA..dule.js gzip 39 kB 39 kB ✓
main-9973c26..dule.js gzip 6.42 kB 6.42 kB ✓
webpack-07c5..dule.js gzip 751 B 751 B ✓
Overall change 52.3 kB 52.3 kB ✓
Legacy Client Bundles (polyfills)
vercel/next.js canary NorbertLuszkiewicz/next.js canary Change
polyfills-4b..e242.js gzip 31 kB 31 kB ✓
Overall change 31 kB 31 kB ✓
Client Pages
vercel/next.js canary NorbertLuszkiewicz/next.js canary Change
_app-9a0b9e1..b37e.js gzip 1.28 kB 1.28 kB ✓
_error-28298..e0c9.js gzip 3.44 kB 3.44 kB ✓
hooks-89731c..c609.js gzip 887 B 887 B ✓
index-17468f..5d83.js gzip 227 B 227 B ✓
link-000f151..65d4.js gzip 1.29 kB 1.29 kB ✓
routerDirect..924c.js gzip 284 B 284 B ✓
withRouter-7..c13d.js gzip 284 B 284 B ✓
Overall change 7.69 kB 7.69 kB ✓
Client Pages Modern
vercel/next.js canary NorbertLuszkiewicz/next.js canary Change
_app-75d3a82..dule.js gzip 625 B 625 B ✓
_error-65c8a..dule.js gzip 2.29 kB 2.29 kB ✓
hooks-cbf13f..dule.js gzip 387 B 387 B ✓
index-b9a643..dule.js gzip 226 B 226 B ✓
link-4cfda7a..dule.js gzip 1.26 kB 1.26 kB ✓
routerDirect..dule.js gzip 284 B 284 B ✓
withRouter-f..dule.js gzip 282 B 282 B ✓
Overall change 5.35 kB 5.35 kB ✓
Client Build Manifests
vercel/next.js canary NorbertLuszkiewicz/next.js canary Change
_buildManifest.js gzip 322 B 322 B ✓
_buildManife..dule.js gzip 330 B 330 B ✓
Overall change 652 B 652 B ✓
Serverless bundles
vercel/next.js canary NorbertLuszkiewicz/next.js canary Change
_error.js 1.03 MB 1.03 MB ✓
404.html 4.22 kB 4.22 kB ✓
hooks.html 3.86 kB 3.86 kB ✓
index.js 1.03 MB 1.03 MB ✓
link.js 1.07 MB 1.07 MB ✓
routerDirect.js 1.07 MB 1.07 MB ✓
withRouter.js 1.07 MB 1.07 MB ✓
Overall change 5.28 MB 5.28 MB ✓
Commit: aa4f75d

@Timer Timer merged commit c03d493 into vercel:canary Aug 30, 2020
lfades
lfades reviewed Sep 1, 2020
View reviewed changes
examples/with-zones/README.md
Comment on lines -37 to -44
Install the dependencies of every app (`/home` and `/blog`):

```bash
npm install
# or
yarn
```

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@NorbertLuszkiewicz This should stay.

lfades
lfades reviewed Sep 1, 2020
View reviewed changes
examples/with-webassembly/README.md
Comment on lines -28 to -38
This example uses Rust compiled to wasm, the wasm file is included in the example, but to compile your own Rust code you'll have to [install](https://www.rust-lang.org/learn/get-started) Rust.

```bash
npm install
npm run dev
# or
yarn
yarn dev
```

To compile `src/add.rs` to `add.wasm` use `npm run build-rust`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@NorbertLuszkiewicz The paragraphs here are important.

lfades
lfades reviewed Sep 1, 2020
View reviewed changes
examples/with-stomp/README.md
Comment on lines -30 to -41
Install it and run:

```bash
npm install
STOMP_SERVER=wss://some.stomp.server npm run dev
# or
yarn
STOMP_SERVER=wss://some.stomp.server yarn dev
```

You'll need to provide the STOMP url of your server in `STOMP_SERVER`

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@NorbertLuszkiewicz This should not be removed.

lfades
lfades reviewed Sep 1, 2020
View reviewed changes
examples/with-rebass/README.md
Comment on lines -34 to -44
Install it and run:

```bash
npm install
ln -f -s ../node_modules/react-md/dist/react-md.light_blue-yellow.min.css static/react-md.light_blue-yellow.min.css
npm run dev
# or
yarn
ln -f -s ../node_modules/react-md/dist/react-md.light_blue-yellow.min.css static/react-md.light_blue-yellow.min.css
yarn dev
```
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should not be removed.

lfades
lfades reviewed Sep 1, 2020
View reviewed changes
examples/with-reason-relay/README.md
Comment on lines -34 to -56
Install it:

```bash
npm install
# or
yarn
```

Download schema introspection data from configured Relay endpoint

```bash
npm run schema
# or
yarn schema
```

Run Relay ahead-of-time compilation (should be re-run after any edits to components that query data with Relay)

```bash
npm run relay
# or
yarn relay
```
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These steps are specific to this example and should not be removed

lfades
lfades reviewed Sep 1, 2020
View reviewed changes
examples/with-http2/README.md
Comment on lines -26 to -31
Create the public and private keys:

```bash
openssl req -x509 -newkey rsa:2048 -nodes -sha256 -subj '/CN=localhost' \
-keyout localhost-privkey.pem -out localhost-cert.pem
```
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should stay.

lfades
lfades reviewed Sep 1, 2020
View reviewed changes
examples/with-firebase-hosting/README.md
Comment on lines -39 to -55
Update `.firebaserc`: adding your firebase project ID

Install it and run:

```bash
npm install
npm run dev
# or
yarn
yarn dev

# to run Firebase locally for testing:
npm run serve

# to deploy it to the cloud with Firebase:
npm run deploy
```
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is important

lfades
lfades reviewed Sep 1, 2020
View reviewed changes
examples/with-algolia-react-instantsearch/README.md
Comment on lines -26 to -29
Set up Algolia:

- create an [algolia](https://www.algolia.com/) account or use this already [configured index](https://community.algolia.com/react-instantsearch/Getting_started.html#before-we-start)
- update the appId, apikey and indexName you want to search on in components/app.js
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is important.

@lfades
Copy link
Member

lfades commented Sep 1, 2020

@NorbertLuszkiewicz I checked all the changed files and commented on the places where there was important information removed. Can you create a PR to undo those changes? 🙏

@lfades lfades mentioned this pull request Sep 3, 2020
Merged
kodiakhq bot pushed a commit that referenced this pull request Sep 3, 2020
@lfades
Undo unrequired readme changes done to examples (#16831)
4162e39 
Related to #16678 (comment)
HitoriSensei pushed a commit to HitoriSensei/next.js that referenced this pull request Sep 26, 2020
@lfades
Undo unrequired readme changes done to examples (vercel#16831)
d6cd01c 
Related to vercel#16678 (comment)
This was referenced May 25, 2021
Open
Open
Open
Open
Open
Open
Open
Open
@vercel vercel locked as resolved and limited conversation to collaborators Jan 30, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@lfades lfades lfades left review comments

@Timer Timer Timer approved these changes

@chibicode chibicode Awaiting requested review from chibicode

@ijjk ijjk Awaiting requested review from ijjk

@timneutkens timneutkens Awaiting requested review from timneutkens

Assignees
No one assigned
Labels
examples Issue was opened via the examples template.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Remove the manual download option from examples
4 participants
@NorbertLuszkiewicz @ijjk @lfades @Timer