Skip to content

Conversation

berthieresteban
Copy link
Contributor

@berthieresteban berthieresteban commented Jul 25, 2019

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
Copy link

codecov bot commented Jul 25, 2019

Codecov Report

Merging #429 into 6-dev will decrease coverage by <.01%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##            6-dev     #429      +/-   ##
==========================================
- Coverage   96.45%   96.45%   -0.01%     
==========================================
  Files          33       33              
  Lines        1553     1550       -3     
==========================================
- Hits         1498     1495       -3     
  Misses         55       55
Impacted Files Coverage Δ
src/protocols/websocket.js 100% <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 93dc100...e71beee. Read the comment docs.

@codecov
Copy link

codecov bot commented Jul 25, 2019

Codecov Report

Merging #429 into 6-dev will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##            6-dev     #429   +/-   ##
=======================================
  Coverage   96.52%   96.52%           
=======================================
  Files          33       33           
  Lines        1556     1556           
=======================================
  Hits         1502     1502           
  Misses         54       54

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 470a513...e4ef5f7. Read the comment docs.

Copy link
Contributor

@Aschen Aschen left a comment

Choose a reason for hiding this comment

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

Instead of putting your getting started app at repository root you can put it in the documentation folder with a hidden directory.
I tried to put the sources in doc/6/getting-started...without-vuex/.src/ and the build is ok

Also why do you need to create the symlink in doc.sh ? It's better for maintainability to keep this script as small as possible

@Aschen Aschen deleted the poc-getting-started-vuejs branch September 20, 2019 12:57
@Aschen Aschen restored the poc-getting-started-vuejs branch September 20, 2019 12:57
@scottinet scottinet deleted the poc-getting-started-vuejs branch November 5, 2019 15:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants