Add getting started Vue.js #431

berthieresteban · 2019-07-29T09:14:59Z

What does this PR do?

This getting-started has been added to the documentation before but removed because vuepress can't build with it.

It was approved in those PR : #405 and #406

Add VueJS getting started without vuex to SDK JS6 documentation.
Resolve the build problem of the vuepress doc (Vuepress tried to build .vue files of the getting-started and crash) by adding symlink.

⚠️ need to add following line in doc/6/getting-started/vuejs/standalone/index.md line 14 after merge:
You can find the full code of this guide [here](https://github.com/kuzzleio/sdk-javascript/tree/6-dev/doc/6/getting-started/vuejs/standalone).⚠️

How should this be manually tested?

See documentation:

Step 1 : npm run doc prepare
Step 2 : npm run doc-dev

Test getting started project (You'll need the CYPRESS_RECORD_KEY as environment variable)

Step 1 : Get a Kuzzle running without anonymous restrictions
Step 2 : cd doc/6/getting-started/vuejs && npm ci
Step 3 : npm run serve-standalone
Step 4 : npm run test

Other changes

/

Boyscout

/

codecov · 2019-07-29T09:21:01Z

Codecov Report

❗ No coverage uploaded for pull request base (6-dev@839b5fe). Click here to learn what that means.
The diff coverage is n/a.

@@           Coverage Diff            @@
##             6-dev     #431   +/-   ##
========================================
  Coverage         ?   96.52%           
========================================
  Files            ?       33           
  Lines            ?     1556           
  Branches         ?        0           
========================================
  Hits             ?     1502           
  Misses           ?       54           
  Partials         ?        0

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 839b5fe...9cc266e. Read the comment docs.

codecov · 2019-07-29T09:21:01Z

Codecov Report

❗ No coverage uploaded for pull request base (6-dev@839b5fe). Click here to learn what that means.
The diff coverage is n/a.

@@           Coverage Diff            @@
##             6-dev     #431   +/-   ##
========================================
  Coverage         ?   96.52%           
========================================
  Files            ?       33           
  Lines            ?     1556           
  Branches         ?        0           
========================================
  Hits             ?     1502           
  Misses           ?       54           
  Partials         ?        0

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 839b5fe...a956d99. Read the comment docs.

codecov-io · 2019-07-29T10:02:13Z

Codecov Report

Merging #431 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #431   +/-   ##
=======================================
  Coverage   95.97%   95.97%           
=======================================
  Files          33       33           
  Lines        1641     1641           
=======================================
  Hits         1575     1575           
  Misses         66       66

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f5befcd...c441bd1. Read the comment docs.

…ng-started-vuejs-standalone

Aschen · 2019-08-02T11:31:49Z

This PR should be on master branch

doc/6/getting-started/.vuejs/cypress/plugins/index.js

doc/6/getting-started/.vuejs/cypress/support/commands.js

doc/6/getting-started/.vuejs/cypress/support/index.js

doc/6/getting-started/vuejs/standalone/index.md

scottinet · 2019-08-07T14:03:00Z

doc/6/getting-started/vuejs/standalone/index.md

+npm install kuzzle-sdk
+```
+
+In the _App.vue_ file, you should remove the tag, the import and the component registration of the `HelloWorld` component, we won't use it.


(nitpicking) I wonder if file names shouldn't be better enclosed between backquotes (i.e. fixed font, grey background) instead of being put in italic.

I used backquotes for properties, method names and HTML tags. Should I do the opposite ?

doc/6/getting-started/vuejs/standalone/index.md

Co-Authored-By: Sébastien Cottinet <scottinet@protonmail.com>

doc/6/getting-started/.vuejs/cypress/support/commands.js

doc/6/getting-started/vuejs/standalone/index.md

Co-Authored-By: Adrien Maret <amaret93@gmail.com> Co-Authored-By: Sébastien Cottinet <scottinet@protonmail.com>

…c.sh

scottinet · 2019-09-09T07:37:22Z

Cypress tests still failing.

…ing-started-vuejs-standalone

…o/sdk-javascript into getting-started-vuejs-standalone

## What does this PR do? This getting-started has been added to the documentation before but removed because vuepress can't build with it. It was approved in those PR : #405 and #406 Add VueJS getting started without vuex to SDK JS6 documentation. Resolve the build problem of the vuepress doc (Vuepress tried to build .vue files of the getting-started and crash) by adding symlink. ![image](https://user-images.githubusercontent.com/44427849/62125816-7b1cc180-b2ce-11e9-83e2-df65d7dbcbd4.png) :warning: need to add following line in doc/6/getting-started/vuejs/standalone/index.md line 14 after merge: ``` You can find the full code of this guide [here](https://github.com/kuzzleio/sdk-javascript/tree/6-dev/doc/6/getting-started/vuejs/standalone).```:warning: ### How should this be manually tested? See documentation: - Step 1 : npm run doc prepare - Step 2 : npm run doc-dev Test getting started project (You'll need the CYPRESS_RECORD_KEY as environment variable) - Step 1 : Get a Kuzzle running without anonymous restrictions - Step 2 : cd doc/6/getting-started/vuejs && npm ci - Step 3 : npm run serve-standalone - Step 4 : npm run test ### Other changes / ### Boyscout /

# Description Import #431 and #436 to v7: commits were cherry-picked, then the getting started directories were moved to the `doc/7` documentation directory. Finally, the `test-doc` script has been adapted to run tests on the v7 version of the getting started. Those are the only changes made, there should be no need to review the full content of this PR (but you may do it if you want to)

berthieresteban self-assigned this Jul 29, 2019

Add getting started Vue.js

a956d99

berthieresteban force-pushed the getting-started-vuejs-standalone branch from b1a6d62 to a956d99 Compare July 29, 2019 09:20

berthieresteban added 2 commits July 29, 2019 11:53

test fix netlify

68a520f

test fix netlify

9cc266e

test fix netlify

149d54f

berthieresteban force-pushed the getting-started-vuejs-standalone branch from e48c4f3 to 149d54f Compare July 29, 2019 10:03

berthieresteban added 6-dev wip do not merge and removed wip labels Jul 29, 2019

alexandrebouthinon removed the do not merge label Aug 1, 2019

Merge branch '6-dev' of github.com:kuzzleio/sdk-javascript into getti…

d25d801

…ng-started-vuejs-standalone

berthieresteban force-pushed the getting-started-vuejs-standalone branch from ccf28f8 to d25d801 Compare August 1, 2019 08:18

refresh index for tests

225d946

scottinet added the changelog:exclude label Aug 2, 2019

scottinet changed the base branch from 6-dev to master August 7, 2019 13:41

scottinet reviewed Aug 7, 2019

View reviewed changes

doc/6/getting-started/.vuejs/cypress/plugins/index.js Show resolved Hide resolved

scottinet reviewed Aug 7, 2019

View reviewed changes

doc/6/getting-started/.vuejs/cypress/support/commands.js Outdated Show resolved Hide resolved

scottinet reviewed Aug 7, 2019

View reviewed changes

doc/6/getting-started/.vuejs/cypress/support/index.js Outdated Show resolved Hide resolved

berthieresteban added the wip label Aug 7, 2019

scottinet suggested changes Aug 8, 2019

View reviewed changes

berthieresteban and others added 4 commits August 16, 2019 14:43

Update doc/6/getting-started/vuejs/standalone/index.md

31afb1c

Co-Authored-By: Sébastien Cottinet <scottinet@protonmail.com>

Update doc/6/getting-started/vuejs/standalone/index.md

9afd13e

Co-Authored-By: Sébastien Cottinet <scottinet@protonmail.com>

Update doc/6/getting-started/vuejs/standalone/index.md

41083c6

Co-Authored-By: Sébastien Cottinet <scottinet@protonmail.com>

Update doc/6/getting-started/vuejs/standalone/index.md

c892487

Co-Authored-By: Sébastien Cottinet <scottinet@protonmail.com>

scottinet suggested changes Aug 20, 2019

View reviewed changes

berthieresteban and others added 2 commits August 23, 2019 11:34

Apply suggestions from code review

50040c4

Co-Authored-By: Adrien Maret <amaret93@gmail.com> Co-Authored-By: Sébastien Cottinet <scottinet@protonmail.com>

flatten + catch promises & delete version.md & previous version of do…

2ebcea5

…c.sh

berthieresteban requested review from Aschen and scottinet August 27, 2019 07:46

berthieresteban added the wip label Aug 27, 2019

Aschen approved these changes Aug 27, 2019

View reviewed changes

berthieresteban mentioned this pull request Aug 29, 2019

Add getting started React #436

Merged

berthieresteban added the do not merge label Sep 3, 2019

berthieresteban and others added 2 commits September 6, 2019 15:49

cypress command

f6caa53

cypress commands

13b08ff

berthieresteban removed do not merge wip labels Sep 6, 2019

typo

d20ca66

xbill82 assigned xbill82 and unassigned berthieresteban Sep 10, 2019

xbill82 added the wip label Sep 10, 2019

berthieresteban added 4 commits October 2, 2019 17:29

cypress tests

8618a39

Merge branch 'master' of github.com:kuzzleio/sdk-javascript into gett…

51cad6e

…ing-started-vuejs-standalone

Merge branch 'getting-started-vuejs-standalone' of github.com:kuzzlei…

d985d97

…o/sdk-javascript into getting-started-vuejs-standalone

cypress tests

c441bd1

berthieresteban removed the wip label Oct 3, 2019

berthieresteban self-assigned this Oct 3, 2019

scottinet approved these changes Oct 11, 2019

View reviewed changes

scottinet merged commit 6ef99ba into master Oct 11, 2019

scottinet deleted the getting-started-vuejs-standalone branch October 11, 2019 13:06

scottinet mentioned this pull request Oct 11, 2019

Import Vue.js and React getting started from v6 #454

Merged

Add getting started Vue.js #431

Add getting started Vue.js #431

Uh oh!

Conversation

berthieresteban commented Jul 29, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What does this PR do?

How should this be manually tested?

Other changes

Boyscout

Uh oh!

codecov bot commented Jul 29, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

codecov bot commented Jul 29, 2019

Codecov Report

Uh oh!

codecov-io commented Jul 29, 2019 • edited by codecov bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Aschen commented Aug 2, 2019

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

scottinet Aug 7, 2019

Choose a reason for hiding this comment

Uh oh!

berthieresteban Aug 16, 2019

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

scottinet commented Sep 9, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

berthieresteban commented Jul 29, 2019 •

edited

Loading

codecov bot commented Jul 29, 2019 •

edited

Loading

codecov-io commented Jul 29, 2019 •

edited by codecov bot

Loading