Skip to content

Conversation

berthieresteban
Copy link
Contributor

@berthieresteban berthieresteban commented Jun 26, 2019

⚠️ depend on #405

What does this PR do?

Add readme to vueJS getting started (without vuex)

How should this be manually tested?

  • Step 1 : clone the documentation repository
  • Step 2 : checkout [377] [feature] Fix indent in imported code snippets documentation#377
  • Step 3 : copy the /doc/6/getting-started/vuejs folder of this branch in documentation repo (/src/sdk/js/6/getting-started) without:
    - node_modules/
    - package-lock.json
    - /without-vuex/node_modules/
  • Step 4 : add the following line before dumpToFile: true, in /src/.vuepress/config.js :
    exclude: ['/sdk/js/6/getting-started/vuejs/without-vuex/src/**/*'],
  • Step 5 : (documentation) npm run dev
  • Step 6 : review

Other changes

/

Boyscout

/

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.

I like this getting started :-) Good work 👍

@codecov
Copy link

codecov bot commented Jul 1, 2019

Codecov Report

Merging #406 into add-vuejs-getting-started will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@                    Coverage Diff                     @@
##           add-vuejs-getting-started     #406   +/-   ##
==========================================================
  Coverage                      96.31%   96.31%           
==========================================================
  Files                             32       32           
  Lines                           1519     1519           
==========================================================
  Hits                            1463     1463           
  Misses                            56       56
Impacted Files Coverage Δ
src/proxify.js 95.23% <0%> (ø) ⬆️
src/controllers/searchResult/base.js 92.85% <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 44e46e0...3a0883e. Read the comment docs.

@codecov
Copy link

codecov bot commented Jul 1, 2019

Codecov Report

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

Impacted file tree graph

@@          Coverage Diff          @@
##           6-dev    #406   +/-   ##
=====================================
  Coverage   96.3%   96.3%           
=====================================
  Files         32      32           
  Lines       1517    1517           
=====================================
  Hits        1461    1461           
  Misses        56      56

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 9e27afa...19db2fc. Read the comment docs.

berthieresteban and others added 4 commits July 1, 2019 09:31
Co-Authored-By: Adrien Maret <amaret93@gmail.com>
Co-Authored-By: Adrien Maret <amaret93@gmail.com>
Co-Authored-By: Adrien Maret <amaret93@gmail.com>
Copy link
Contributor

@xbill82 xbill82 left a comment

Choose a reason for hiding this comment

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

🙌 High fives buddy, good job.
Please, take a look at my nitpickings and add a line indicating that the whole code is contained in the repo with a link to the folder, so that users may have the big picture of the whole project.

@xbill82 xbill82 changed the base branch from add-vuejs-getting-started to 6-dev July 1, 2019 09:44
berthieresteban and others added 13 commits July 1, 2019 11:45
Co-Authored-By: Luca Marchesini <xbill82@gmail.com>
…leio/sdk-javascript into add-readme-to-vuejs-getting-started
Co-Authored-By: Luca Marchesini <xbill82@gmail.com>
Co-Authored-By: Luca Marchesini <xbill82@gmail.com>
Co-Authored-By: Luca Marchesini <xbill82@gmail.com>
Co-Authored-By: Luca Marchesini <xbill82@gmail.com>
Co-Authored-By: Luca Marchesini <xbill82@gmail.com>
Co-Authored-By: Luca Marchesini <xbill82@gmail.com>
Co-Authored-By: Luca Marchesini <xbill82@gmail.com>
…leio/sdk-javascript into add-readme-to-vuejs-getting-started

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.

## Instanciating Kuzzle SDK
Copy link
Contributor

Choose a reason for hiding this comment

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

better, no?

Suggested change
## Instanciating Kuzzle SDK
## Instanciate Kuzzle SDK

@Aschen Aschen merged commit 438cd4b into 6-dev Jul 1, 2019
@Aschen Aschen deleted the add-readme-to-vuejs-getting-started branch July 1, 2019 11:44
berthieresteban added a commit that referenced this pull request Jul 1, 2019
@berthieresteban berthieresteban restored the add-readme-to-vuejs-getting-started branch July 1, 2019 12:18
berthieresteban added a commit that referenced this pull request Jul 1, 2019
What does this PR do?
just add the requested changes of #405 because removed by #406
@Aschen Aschen mentioned this pull request Jul 1, 2019
@berthieresteban berthieresteban deleted the add-readme-to-vuejs-getting-started branch July 2, 2019 07:43
This was referenced Jul 25, 2019
scottinet pushed a commit that referenced this pull request Oct 11, 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.

![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
/
scottinet pushed a commit that referenced this pull request Oct 11, 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.

![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
/
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants