Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release 1.1.0 #336

Closed
wants to merge 68 commits into from
Closed

Release 1.1.0 #336

wants to merge 68 commits into from

Conversation

xbill82
Copy link
Contributor

@xbill82 xbill82 commented Jun 12, 2019

1.1.0 (2019-06-12)

Bug fixes

New features

  • [ #299 ] Documentation for wildcard events (thomasarbona)
  • [ #321 ] Add guide about secrets management with the Vault (Aschen)
  • [ #300 ] Add page about bulk:write and bulk:mwrite (Aschen)

Enhancements

Others


Aschen and others added 30 commits March 29, 2019 13:26
Adds a documentation essentials page about mappings:

dynamic mapping policy
collection metadata
properties types definitions
Also update SDKs

See kuzzleio/kuzzle#1257
Documentation for embedded protocols, notably for MQTT.
Add a page about how to extend the JS SDK with custom controllers.  
https://deploy-preview-284--kuzzle-doc-v2.netlify.com/sdk-reference/js/6/extend-sdk/

Also document:
 - BaseController class
 - Kuzzle.useController method

See kuzzleio/sdk-javascript#388
## What does this PR do?

This PR responds to this [ticket](https://jira.kaliop.net/browse/KZL-907).
Also, it increases the readability of documentation's plugin part.

### How should this be manually tested?

[Netify](https://deploy-preview-276--kuzzle-doc-v2.netlify.com/plugins/1/essentials/introduction/)

### Other changes

- Re-arrange plugin documentation path
- Update dead link in boilerplate repository

### Boyscout

Prettier
Remove useless since 1.0.0 tag
Add Since 6.1.1 for extends SDK page
## What does this PR do?

Add an explicit template role to [createRole](https://docs.kuzzle.io/api/1/controller-security/create-role/)

https://jira.kaliop.net/browse/KZL-1050

### How should this be manually tested?

Netify
Add S3 plugin to official plugin listing
Getting started React + improve snippetManager
benoitvidis and others added 27 commits June 4, 2019 11:52
## What does this PR do?

This PR fixes the sdk JS tests

NB: As a dependency, the `kuzzleio/documentation:js` docker image has been updated and manually pushed to docker hub (should not impact other PRs)
## What does this PR do?

Remove debug statement from snippet code
Deprecate realtime:join
Rewrite the guide about the real-time engine

Add getting started category in SDK JS6 side menu instead of in essentials.
Add an advanced guide about clustering/scalability (I want these 2 words to be referenced by Algolia). URL path: core/1/guides/kuzzle-depth/scalability/
Remove obsolete information from the plugin guide. URL path: /core/1/guide/guides/essentials/plugins
## What does this PR do?

- Update the API documentation because of this PR: kuzzleio/kuzzle#1300

### How should this be manually tested?

  - Step 1 : `npm install && npm run dev`
  - Step 2 : visit http://localhost:8080/core/1/api/api-reference/controller-collection/validate-specifications/
  - Step 3 : visit http://localhost:8080/core/1/api/api-reference/controller-collection/update-specifications/
## What does this PR do?

Adds automatic builds to documentation.
Builds will be deployed to https://docs.kuzzle.io when merged to `master` and to https://nex-docs.kuzzle.io on `3-dev`.

Thanks to node 10 and possibly the upgrade of vuepress, the build can be generated in a relatively acceptable time (~35mn, i.e. https://travis-ci.org/kuzzleio/documentation/jobs/541275090).

### Other changes

- upgrade `vuepress` to 1.0.0-beta.1
What does this PR do?

I forget to check link like this: <a href="/core/1/...">

This PR fix remaining dead links and updates the script

I also added the script to travis to check for dead links before merging
## What does this PR do?

Document kuzzleio/sdk-javascript#390

Based on #315

Original PR on v2: #297
<!--
  This template is optional.
  It simply serves to provide a guide to allow a better review of pull requests.
-->

<!--
  IMPORTANT
  Don't forget to add the corresponding "changelog:xxx" label to your PR.
  This is part of our release process in order to generate the change log.
-->


## What does this PR do?

Adapt legacy redirection to forward request to doc v3

### How should this be manually tested?

<!--
  Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce.
  Please also list any relevant details for your test configuration
-->
  - Step 1 :
  - Step 2 :
  - Step 3 :  
  ...

### Other changes

<!--
  Please describe here all changes not directly linked to the main issue, but made because of it.
  For instance: issues spotted during this PR and fixed on-the-fly, dependencies update, and so on
-->

### Boyscout

<!--
  Describe here minor improvements in the code base and not directly linked to the main changes:
  typos fixes, better/new comments, small code simplification, new debug messages, and so on.
-->
Update Redis 3 to Redis 3 or higher
* Fix bulk import return
* Update src/core/1/api/api-reference/controller-bulk/import/index.md
* Update src/sdk/js/6/controllers/bulk/import/snippets/import.js
## What does this PR do?

Document the secrets Vault.  
Also add a page for the new `context.secrets` object exposed in plugin context

kuzzleio/kuzzle#1315

### How should this be manually tested?

<!--
  Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce.
  Please also list any relevant details for your test configuration
-->
  - Step 1 :
  - Step 2 :
  - Step 3 :  
  ...

### Other changes

<!--
  Please describe here all changes not directly linked to the main issue, but made because of it.
  For instance: issues spotted during this PR and fixed on-the-fly, dependencies update, and so on
-->

### Boyscout

<!--
  Describe here minor improvements in the code base and not directly linked to the main changes:
  typos fixes, better/new comments, small code simplification, new debug messages, and so on.
-->
What does this PR do?

Replaces all the <a> tags in the Sidebar component (and others) with <router-link> so that the entire website behaves like an SPA after first load.

Thanks to @alexandrebouthinon for helping on this! tada
* fix(hilight-code): replace javascript by js
* [fix] clean out shell and plaintext
Doc was missing, I restored it from #262
## What does this PR do?

https://jira.kaliop.net/browse/KZL-1204

Disables the Java snippet tests, since they are executed on the Swig version of the SDK and are not reliable.
## What does this PR do?
<!-- Please fulfill this section -->

<!--
  Please include a summary of the change and which issue is fixed.
  Please also include relevant motivation and context.
  List any dependencies that are required for this change.
-->

  - useless spoiler on the realtime guide
  - adds a warning for the Vault guide
  - `plaintext` type does not exists
- add documentation for wildcard events (kuzzleio/kuzzle#1305)

### How should this be manually tested?

- `npm install && npm run dev`
- visit http://localhost:8080/core/1/plugins/plugins/events/wildcard-events/

### Boyscout

- [ @xbill82  ] Disabled C++ and Java tests from local execution
- fix pages sorting (page with an order set to 0 isn't classified first)
@xbill82 xbill82 closed this Jun 12, 2019
@xbill82 xbill82 deleted the 1.1.0-proposal branch June 12, 2019 15:28
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.

10 participants