Skip to content

Conversation

scottinet
Copy link
Contributor

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 and others added 3 commits October 11, 2019 15:40
## 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
/
## What does this PR do?
Add Kuzzle React getting-started.

This getting-started have been merge in the last doc [#291](kuzzleio/documentation#291)

The last getting started app was builted progressively and some code was rewrite during the reading. 
I had to rewrite lot of parts to remove that because it implicated some untested lines. I avoid hard snippets written in the readme too.

I removed the tested snippets and add cypress to test the app globally.

The app use the current 6-dev sdk version with the ugly post-install line in `doc/6/getting-started/.react/package.json`

### How should this be manually tested?

  - Step 0 : Kuzzle running stack
  - Step 1 : cd doc/6/getting-started/.react
  - Step 2 : yarn install
  - Step 3 : yarn start &  (if error add `SKIP_PREFLIGHT_CHECK=true`)
  - Step 4 : npm run test

### Other changes
/

### Boyscout
/
@Aschen Aschen merged commit 00bf113 into 7-dev Oct 15, 2019
@Aschen
Copy link
Contributor

Aschen commented Oct 15, 2019

Test will be fixed in a different PR

@Aschen Aschen deleted the add-getting-started branch October 15, 2019 01:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants