KZL-861 Getting started with Webpack #164

xbill82 · 2018-11-26T16:07:35Z

Adds the Getting Started with Webpack in the Kuzzle JS SDK section.

Note that this guide introduced a new test runner called WebpackRunner, which builds the snippet and generates an HTML page loading it, then opens the page with Puppeteer.

How should this be manually tested?

Check Netlify build.

kuzzle · 2018-11-26T16:47:01Z

Snippets tests reports

SDK	Version	Tests overview
	v6	✔️
	v5	✔️
	v1	✔️
	v1	✔️
	v1	✔️
	v1	✔️

etrousset

Nice job.
Some inline code snippets don't have the same syntax coloration than the ones using the snippet inclusion mechanism
This may be due to using ```javascript instead of ``` js

etrousset · 2019-02-22T09:35:32Z

src/sdk-reference/js/6/getting-started/webpack/index.md

+In this tutorial you will learn how to install, run and use **Kuzzle** with the **Javascript SDK** in the browser using **Webpack**.
+We will walk you through creating scripts that can **store** documents in Kuzzle and subscribe to **notifications** for each new document created.
+
+## Running Kuzzle


I would remove this section and just add a note that have a Kuzzle running is a prerequisite, with a link to https://docs-v2.kuzzle.io/guide/1/getting-started/running-kuzzle/ that has the exact same text

src/sdk-reference/js/6/getting-started/webpack/index.md

test/lib/runners/webpackRunner.js

test/lib/scripts/puppeteer.js

scottinet · 2019-02-22T10:34:38Z

test/lib/sdk/jsSdk.js

      return false;
    }

    const versionString = JSON.parse(fs.readFileSync(packageFile))._id;

-    if (! versionString || ! versionString.includes(`kuzzle-sdk@${this.version}`)) {
+    if (


(nitpicking) lines 28-35 can be simplified:

return versionString && versionString.includes(`kuzzle-sdk@${this.version}`);

Other than taking 2 ! away from the code, I don't see the point of changing this. Not my code, btw. Ended here because of Prettier 🤷‍♀️

This is a nitpicking issue, so it doesn't matter 👍
(it removes the entire if (condition is false) { return true; } else { return false; } condition)

test/templates/webpack-puppeteer.tpl.js

scottinet · 2019-02-25T10:18:49Z

@xbill82 > there are issues I've raised that are still to be resolved, such as https://github.com/kuzzleio/documentation/pull/164/files#r259288069

alexandrebouthinon

@xbill82 : I think you need to rebase/merge your branch on 2-dev instead of master 🙂

src/sdk-reference/js/6/getting-started/index.md

src/sdk-reference/js/6/getting-started/webpack/index.md

Co-Authored-By: xbill82 <[email protected]>

KZL-1021 Fix algolia links

# [2.1.0](https://github.com/kuzzleio/documentation/releases/tag/2.1.0) (2019-03-26) #### Bug fixes - [ [#251](#251) ] Fix ssl option name for android ([jenow](https://github.com/jenow)) #### New features - [ [#164](#164) ] KZL-861 Getting started with Webpack ([xbill82](https://github.com/xbill82)) #### Enhancements - [ [#252](#252) ] Add loading of fixtures mappings securities in admin controller ([Aschen](https://github.com/Aschen)) - [ [#253](#253) ] Plugin embedded sdk ([Aschen](https://github.com/Aschen)) - [ [#249](#249) ] Better example for SearchResult.next ([Aschen](https://github.com/Aschen)) #### Others - [ [#262](#262) ] [API] new auth:refreshToken API route documentation ([scottinet](https://github.com/scottinet)) - [ [#257](#257) ] KZL-1054 Fix Node.js SDK Getting Started subscription ([xbill82](https://github.com/xbill82)) - [ [#263](#263) ] [debug] Print standard output on an assertion error ([scottinet](https://github.com/scottinet)) ---

xbill82 added wip changelog:new-features labels Nov 26, 2018

xbill82 self-assigned this Nov 26, 2018

xbill82 removed the wip label Feb 21, 2019

xbill82 requested review from Njuelle, Aschen and scottinet February 21, 2019 15:05

etrousset requested changes Feb 22, 2019

View reviewed changes

scottinet suggested changes Feb 22, 2019

View reviewed changes

xbill82 requested review from scottinet and etrousset February 25, 2019 08:54

scottinet approved these changes Feb 26, 2019

View reviewed changes

etrousset approved these changes Feb 27, 2019

View reviewed changes

alexandrebouthinon requested changes Feb 27, 2019

View reviewed changes

Njuelle suggested changes Feb 27, 2019

View reviewed changes

src/sdk-reference/js/6/getting-started/index.md Outdated Show resolved Hide resolved

src/sdk-reference/js/6/getting-started/webpack/index.md Outdated Show resolved Hide resolved

Njuelle approved these changes Feb 27, 2019

View reviewed changes

xbill82 and others added 12 commits February 27, 2019 14:53

First draft of Getting Started with Webpack

7fbee44

WIP webpack puppeteer template

6f19daa

Review of text and snippets

aba2e60

First draft of build with webpack

af48ec7

Setting up Docker environment

97405b0

First webpack test working

757dc3a

Webpack tests WORKING

d9ad578

naming

ef2c5d9

cleanup package.js

3e6030c

Update src/sdk-reference/js/6/getting-started/webpack/index.md

73c8464

Co-Authored-By: xbill82 <[email protected]>

Update src/sdk-reference/js/6/getting-started/webpack/index.md

8cc0aac

Co-Authored-By: xbill82 <[email protected]>

Update src/sdk-reference/js/6/getting-started/webpack/index.md

214329b

Co-Authored-By: xbill82 <[email protected]>

scottinet and others added 12 commits February 27, 2019 14:58

Update src/sdk-reference/js/6/getting-started/webpack/index.md

792bad8

Co-Authored-By: xbill82 <[email protected]>

Update src/sdk-reference/js/6/getting-started/webpack/index.md

f1e3c01

Co-Authored-By: xbill82 <[email protected]>

Update src/sdk-reference/js/6/getting-started/webpack/index.md

7e906a7

Co-Authored-By: xbill82 <[email protected]>

Update src/sdk-reference/js/6/getting-started/webpack/index.md

326665b

Co-Authored-By: xbill82 <[email protected]>

Update src/sdk-reference/js/6/getting-started/webpack/index.md

6d4ba83

Co-Authored-By: xbill82 <[email protected]>

Update test/lib/runners/webpackRunner.js

2be81d4

Co-Authored-By: xbill82 <[email protected]>

Update test/lib/runners/webpackRunner.js

b7c6097

Co-Authored-By: xbill82 <[email protected]>

Applied remarks from @scottinet and @etrousset

2b3f60f

Update test/lib/runners/webpackRunner.js

bb996b9

Co-Authored-By: xbill82 <[email protected]>

Update test/lib/runners/webpackRunner.js

7694e80

Co-Authored-By: xbill82 <[email protected]>

Update src/sdk-reference/js/6/getting-started/webpack/index.md

d2c1a98

Co-Authored-By: xbill82 <[email protected]>

KZL-1021 Fix algolia links

7735f2c

KZL-1021 Fix algolia links

xbill82 force-pushed the KZL-861-getting-started-webpack branch from 16dc2db to 7735f2c Compare February 27, 2019 13:59

alexandrebouthinon changed the base branch from master to 2-dev February 27, 2019 14:04

alexandrebouthinon approved these changes Feb 27, 2019

View reviewed changes

alexandrebouthinon merged commit c591823 into 2-dev Feb 27, 2019

alexandrebouthinon deleted the KZL-861-getting-started-webpack branch February 27, 2019 14:42

scottinet mentioned this pull request Mar 26, 2019

Release 2.1.0 #270

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

KZL-861 Getting started with Webpack #164

KZL-861 Getting started with Webpack #164

xbill82 commented Nov 26, 2018 •

edited

Loading

kuzzle commented Nov 26, 2018 •

edited

Loading

etrousset left a comment •

edited

Loading

etrousset Feb 22, 2019

scottinet Feb 22, 2019

xbill82 Feb 25, 2019

scottinet Feb 25, 2019

scottinet commented Feb 25, 2019

alexandrebouthinon left a comment

KZL-861 Getting started with Webpack #164

KZL-861 Getting started with Webpack #164

Conversation

xbill82 commented Nov 26, 2018 • edited Loading

How should this be manually tested?

kuzzle commented Nov 26, 2018 • edited Loading

Snippets tests reports

etrousset left a comment • edited Loading

Choose a reason for hiding this comment

etrousset Feb 22, 2019

Choose a reason for hiding this comment

scottinet Feb 22, 2019

Choose a reason for hiding this comment

xbill82 Feb 25, 2019

Choose a reason for hiding this comment

scottinet Feb 25, 2019

Choose a reason for hiding this comment

scottinet commented Feb 25, 2019

alexandrebouthinon left a comment

Choose a reason for hiding this comment

xbill82 commented Nov 26, 2018 •

edited

Loading

kuzzle commented Nov 26, 2018 •

edited

Loading

etrousset left a comment •

edited

Loading