[KZL-907] Getting started dev plugin #276

Yoann-Abbes · 2019-04-10T13:32:55Z

What does this PR do?

This PR responds to this ticket.
Also, it increases the readability of documentation's plugin part.

How should this be manually tested?

Netify

Other changes

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

Boyscout

Prettier

kuzzle · 2019-04-10T14:01:43Z

Snippets tests reports

SDK	Version	Tests overview
	v6	✔️
	v5	✔️
	v1	✔️
	v1	✔️
	v1	✔️
	v1	✔️

benoitvidis

It is probably just me, but the previous version was looking simpler to me, especially by having a dedicated "Getting started" page.

src/plugins/1/plugin-layout/prerequis/index.md

src/plugins/1/strategies/index.md

alexandrebouthinon · 2019-04-16T14:55:13Z

src/plugins/1/plugin-boilerplate/index.md

+
+<div class="alert alert-info">
+You can find more information about the <code>init</code> function <a href="https://docs.kuzzle.io/plugins/1/plugin-layout/init-function/"> here</a>.
+</div>


Thanks to the markdown master 🥇

scottinet

When clicking on a deployable menu (for instance, Plugin Layout), the Plugin menu head disappears.
That Plugins entry should be a separator IMO
the Introduction page still mentions "chapters", but it should now be "pages"
I'm not sure that the term boilerplate is widespread enough to use it as a menu entry (dictionary definition ). I would replace the Plugin Boilerplate menu entry with Getting Started
Plugin Layout is not bad per se, but I don't find it clear enough... To be debated, but I would propose something like Manual setup

…documentation into KZL-907-plugin-getting-started

src/plugins/1/essentials/getting-started/index.md

Co-Authored-By: Yoann-Abbes <[email protected]>

scottinet

Another requested change: Hooks, Pipes and Controllers documentation are now in the Essentials menu, while Strategies are described at root level. These 4 items should always be at the same level, because they are about different plugins features, there is nothing fundamentally different about them.

src/plugins/1/essentials/getting-started/index.md

src/plugins/1/essentials/hooks/index.md

Co-Authored-By: Yoann-Abbes <[email protected]>

Yoann-Abbes · 2019-04-24T09:26:01Z

@scottinet apparently it's not possible to have 3 levels like Essentials->Strategies->Overview. The menu does not support it without losing the head menu
Plus, is it good to have 3 depth levels ?
Since we want the authentication methods in a separate file, i can't have Strategies in a single file to prevent a third level.

scottinet · 2019-04-24T09:28:03Z

Then move the others out of Essentials

src/plugins/1/hooks/Documentation/index.md

Co-Authored-By: Yoann-Abbes <[email protected]>

* Add documentation page about mappings (#271) Adds a documentation essentials page about mappings: dynamic mapping policy collection metadata properties types definitions Also update SDKs See kuzzleio/kuzzle#1257 * Embedded protocols (#286) Documentation for embedded protocols, notably for MQTT. * Extending the JS SDK with controllers (#284) 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 * [KZL-907] Getting started dev plugin (#276) ## 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 * Release 2.1.1

# [3.0.0](https://github.com/kuzzleio/documentation/releases/tag/3.0.0) (2019-06-12) #### Bug fixes - [ [#298](#298) ] Fix bulk import return ([Aschen](https://github.com/Aschen)) - [ [#325](#325) ] Adapt legacy redirection ([Aschen](https://github.com/Aschen)) - [ [#322](#322) ] Fix remaining dead links and add check_link to CI ([Aschen](https://github.com/Aschen)) - [ [#304](#304) ] Fix sdk js tests ([benoitvidis](https://github.com/benoitvidis)) #### New features - [ [#299](#299) ] Documentation for wildcard events ([thomasarbona](https://github.com/thomasarbona)) - [ [#321](#321) ] Add guide about secrets management with the Vault ([Aschen](https://github.com/Aschen)) - [ [#300](#300) ] Add page about bulk:write and bulk:mwrite ([Aschen](https://github.com/Aschen)) #### Enhancements - [ [#327](#327) ] SPA mode ([xbill82](https://github.com/xbill82)) - [ [#324](#324) ] Update Redis version ([Aschen](https://github.com/Aschen)) - [ [#316](#316) ] Sdks authenticated connected props ([Aschen](https://github.com/Aschen)) - [ [#317](#317) ] Add new way for updateSpecifications & validateSpecifications ([thomasarbona](https://github.com/thomasarbona)) - [ [#296](#296) ] Rewrite the Realtime guide ([Aschen](https://github.com/Aschen)) - [ [#301](#301) ] Deprecate realtime join ([Aschen](https://github.com/Aschen)) - [ [#291](#291) ] Getting started React + improve snippetManager ([thomasarbona](https://github.com/thomasarbona)) - [ [#294](#294) ] Add s3 plugin ([Aschen](https://github.com/Aschen)) - [ [#292](#292) ] Add since ([Aschen](https://github.com/Aschen)) - [ [#276](#276) ] [KZL-907] Getting started dev plugin ([Yoann-Abbes](https://github.com/Yoann-Abbes)) - [ [#284](#284) ] Extending the JS SDK with controllers ([Aschen](https://github.com/Aschen)) - [ [#271](#271) ] Add documentation page about mappings ([Aschen](https://github.com/Aschen)) #### Others - [ [#314](#314) ] Add a clustering guide ([scottinet](https://github.com/scottinet)) - [ [#319](#319) ] Getting-started-sdk-JS6-architecture ([berthieresteban](https://github.com/berthieresteban)) - [ [#311](#311) ] Add PDF sending example for Request.setResult ([Aschen](https://github.com/Aschen)) - [ [#315](#315) ] Normalize directories and generate redirections ([Aschen](https://github.com/Aschen)) - [ [#309](#309) ] Port #284 to 3-dev ([berthieresteban](https://github.com/berthieresteban)) - [ [#308](#308) ] Port #283 to 3-dev ([berthieresteban](https://github.com/berthieresteban)) - [ [#307](#307) ] Port #282 to 3-dev ([berthieresteban](https://github.com/berthieresteban)) - [ [#306](#306) ] Port #280 to 3-dev ([berthieresteban](https://github.com/berthieresteban)) - [ [#312](#312) ] Port 278 to 3-dev ([Aschen](https://github.com/Aschen)) - [ [#310](#310) ] Port #277 to 3-dev ([Aschen](https://github.com/Aschen)) - [ [#305](#305) ] Port #275 to 3-dev ([Aschen](https://github.com/Aschen)) - [ [#303](#303) ] Port #274 to 3-dev ([Aschen](https://github.com/Aschen)) - [ [#302](#302) ] Port #271 to 3-dev ([Aschen](https://github.com/Aschen)) - [ [#313](#313) ] Port #266 to 3-dev ([Yoann-Abbes](https://github.com/Yoann-Abbes)) - [ [#290](#290) ] [KZL-1050] Role template example in the documentation ([Yoann-Abbes](https://github.com/Yoann-Abbes)) - [ [#293](#293) ] [KZL-1036] Add available plugins ([Yoann-Abbes](https://github.com/Yoann-Abbes)) - [ [#286](#286) ] Embedded protocols ([benoitvidis](https://github.com/benoitvidis)) ---

Yoann-Abbes and others added 2 commits April 10, 2019 15:25

archy plugin path

ee79d5b

Merge branch '2-dev' into KZL-907-plugin-getting-started

b060caa

Yoann-Abbes self-assigned this Apr 10, 2019

Yoann-Abbes added changelog:enhancements wip labels Apr 10, 2019

Yoann-Abbes added 3 commits April 10, 2019 16:26

intro

9787535

archy plugin path

a58840a

boilerplate

320b5b1

Yoann-Abbes removed the wip label Apr 15, 2019

benoitvidis suggested changes Apr 16, 2019

View reviewed changes

src/plugins/1/plugin-layout/prerequis/index.md Outdated Show resolved Hide resolved

src/plugins/1/strategies/index.md Show resolved Hide resolved

Yoann-Abbes added the wip label Apr 16, 2019

Yoann-Abbes and others added 2 commits April 16, 2019 11:44

Merge branch '2-dev' into KZL-907-plugin-getting-started

4214507

request changes @benoitvidis

3de580d

Yoann-Abbes added wip and removed wip labels Apr 16, 2019

markdown master

e7b6ed2

Yoann-Abbes requested a review from alexandrebouthinon April 16, 2019 14:52

Yoann-Abbes removed the wip label Apr 16, 2019

alexandrebouthinon reviewed Apr 16, 2019

View reviewed changes

alexandrebouthinon approved these changes Apr 16, 2019

View reviewed changes

Yoann-Abbes requested a review from benoitvidis April 16, 2019 15:01

Merge branch '2-dev' into KZL-907-plugin-getting-started

2e4caca

scottinet suggested changes Apr 17, 2019

View reviewed changes

Yoann-Abbes added 2 commits April 17, 2019 14:37

requested changes @scottinet

eb0723c

Merge branch 'KZL-907-plugin-getting-started' of github.com:kuzzleio/…

ab86825

…documentation into KZL-907-plugin-getting-started

Yoann-Abbes requested a review from scottinet April 17, 2019 12:50

Aschen reviewed Apr 17, 2019

View reviewed changes

src/plugins/1/essentials/getting-started/index.md Outdated Show resolved Hide resolved

benoitvidis approved these changes Apr 17, 2019

View reviewed changes

requested changes @Aschen

91cdbb4

Yoann-Abbes requested a review from Aschen April 17, 2019 14:20

requested changes

4266a69

Aschen suggested changes Apr 18, 2019

View reviewed changes

src/plugins/1/essentials/getting-started/index.md Outdated Show resolved Hide resolved

src/plugins/1/essentials/getting-started/index.md Outdated Show resolved Hide resolved

Aschen suggested changes Apr 23, 2019

View reviewed changes

src/plugins/1/essentials/getting-started/index.md Outdated Show resolved Hide resolved

Update src/plugins/1/essentials/getting-started/index.md

1ad5383

Co-Authored-By: Yoann-Abbes <[email protected]>

Aschen approved these changes Apr 23, 2019

View reviewed changes

scottinet suggested changes Apr 24, 2019

View reviewed changes

scottinet and others added 2 commits April 24, 2019 10:31

Update src/plugins/1/essentials/getting-started/index.md

6f551e3

Co-Authored-By: Yoann-Abbes <[email protected]>

Update src/plugins/1/essentials/hooks/index.md

587052f

Co-Authored-By: Yoann-Abbes <[email protected]>

getting started

2959acb

requested changes @scottinet

f911afb

Yoann-Abbes requested a review from scottinet April 24, 2019 12:35

scottinet suggested changes Apr 25, 2019

View reviewed changes

src/plugins/1/hooks/Documentation/index.md Outdated Show resolved Hide resolved

scottinet and others added 2 commits April 26, 2019 01:33

Update src/plugins/1/hooks/Documentation/index.md

1870fbe

Co-Authored-By: Yoann-Abbes <[email protected]>

Merge branch '2-dev' into KZL-907-plugin-getting-started

3ea0ca8

Yoann-Abbes requested a review from scottinet April 25, 2019 23:33

Merge branch '2-dev' into KZL-907-plugin-getting-started

289a7e2

scottinet approved these changes Apr 26, 2019

View reviewed changes

scottinet and others added 2 commits April 26, 2019 11:27

Merge branch '2-dev' into KZL-907-plugin-getting-started

889d5e7

Merge branch '2-dev' into KZL-907-plugin-getting-started

64d002d

scottinet merged commit 15bb02b into 2-dev Apr 26, 2019

scottinet deleted the KZL-907-plugin-getting-started branch April 26, 2019 12:57

kuzzle mentioned this pull request Apr 29, 2019

Release 2.1.1 #289

Merged

This was referenced Jun 12, 2019

Release 1.1.0 #336

Closed

Release 3.0.0 #337

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[KZL-907] Getting started dev plugin #276

[KZL-907] Getting started dev plugin #276

Yoann-Abbes commented Apr 10, 2019 •

edited

Loading

kuzzle commented Apr 10, 2019 •

edited

Loading

benoitvidis left a comment

alexandrebouthinon Apr 16, 2019

Yoann-Abbes Apr 16, 2019

scottinet left a comment •

edited

Loading

scottinet left a comment

Yoann-Abbes commented Apr 24, 2019 •

edited

Loading

scottinet commented Apr 24, 2019

[KZL-907] Getting started dev plugin #276

[KZL-907] Getting started dev plugin #276

Conversation

Yoann-Abbes commented Apr 10, 2019 • edited Loading

What does this PR do?

How should this be manually tested?

Other changes

Boyscout

kuzzle commented Apr 10, 2019 • edited Loading

Snippets tests reports

benoitvidis left a comment

Choose a reason for hiding this comment

alexandrebouthinon Apr 16, 2019

Choose a reason for hiding this comment

Yoann-Abbes Apr 16, 2019

Choose a reason for hiding this comment

scottinet left a comment • edited Loading

Choose a reason for hiding this comment

scottinet left a comment

Choose a reason for hiding this comment

Yoann-Abbes commented Apr 24, 2019 • edited Loading

scottinet commented Apr 24, 2019

Yoann-Abbes commented Apr 10, 2019 •

edited

Loading

kuzzle commented Apr 10, 2019 •

edited

Loading

scottinet left a comment •

edited

Loading

Yoann-Abbes commented Apr 24, 2019 •

edited

Loading