Merge pull request from influxdata/docs/influxdb-steps

Create documentation for updating api client and updating swagger
pull/12023/head
Palakp41 2019-02-20 15:04:05 -08:00 committed by GitHub
commit b821b250fc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 32 additions and 0 deletions

15
docs/UpdatingAPICLient.md Normal file
View File

@ -0,0 +1,15 @@
## Updating the API Client
* Clone influxdata/influxdb2-js repo, if you havent
* cd influxdata/influxdb2-js
* git pull on master
* git checkout -b “branch name”
* open the repo in vs code
* update the wrapper class with correct api call and return value
* run npm run build && npm run lint in the influxdb2-js dir
* git add the changed files
* send a pr for the update to brandon?
* git pull master on influxdb repo
* update the package.json with correct version number
* restart npm

17
docs/UpdatingSwagger.md Normal file
View File

@ -0,0 +1,17 @@
## Updating the Swagger.yml
* get latest from master
* create a separate branch
* update swagger.yml with your change
* once the change is merged in master, cd into influxdb2-js dir
* get latest from master and create a separate branch
* run npm run generate command in influxdb2-js dir
* npm run buid && npm run lint
* git status
* git add .
* git commit -m “message”
* git push
* create pr and merge it in
* get latest from master
* create a separate branch
* update influxdb2-js in package.json with correct version