Normalize directories and generate redirections #315

Aschen · 2019-05-31T14:28:05Z

What does this PR do?

Some structure changes:

api/api-reference/controller-xxx => api/controllers/xxx
guide/guides/xxx => guides/xxx
plugins/plugins/xxx => split entre plugins/guides/xxx et plugins/essentials
protocols/protocols/xxx => split entre protocols/api/xxx, protocols/essentials/xxx et protocols/native-protocols/xxx

JS 5, PHP 3 and Android 3 SDK are now on the same structures as the other SDK (core-classes, essentials)

The file redirections.yml contain all the redirection from the old v2 pages to new v3 pages.
Paths like api/1/controller-document are root path, redirection for files in subfolders has to be handled.

The script check_redirections.rb checks that every page from v2 has a redirection in v3.

I also replace every links after renaming/moving directories. (Maybe I miss some links but Vuepress have a dead link checker)

How to review it

Since a LOT of files have been moved, it's better to checkout the branch, run npm run dev and browse the documentation manually.

scottinet

(there must be other non-converted URL to fix, but since you're now aware of the issue I'll let you handle it ;) )

scottinet · 2019-06-03T08:33:12Z

src/core/1/guides/essentials/document-metadata/index.md

+
+## Overview
+
+Metadata can be viewed in the document's `_meta` field and contains the following properties:


missing since+deprecated property

something like that: <SinceBadge version="1.0.0" /> <DeprecatedBadge version="1.3.0" />

src/core/1/guides/essentials/document-metadata/index.md

src/core/1/guides/essentials/installing-console/index.md

src/core/1/guides/essentials/security/index.md

src/core/1/guides/kuzzle-depth/authentication/index.md

src/core/1/plugins/guides/controllers/index.md

Co-Authored-By: Sébastien Cottinet <[email protected]>

… into clean-directories

benoitvidis

The Guides entry link is broken in the main tabs menu.
In Tabs.vue => generateLink('core/1/guides')" (with an ending s)

scottinet

one tiny issue left, otherwise this looks good to me

scottinet · 2019-06-03T13:00:34Z

check_link.rb

 require 'json'
 require 'uri'
 require 'typhoeus'
 require 'optparse'

 class LinkChecker
-  INTERNAL_LINK_REGEXP = /\(\{\{\s*site_base_path\s*\}\}([^)>]+)/
+  INTERNAL_LINK_REGEXP = /\[[\.\w\s\-]+\]\(([\w\/\-\#]*)\)/
+  # INTERNAL_LINK_REGEXP = /\(\{\{\s*site_base_path\s*\}\}([^)>]+)/


Delete this line, and all other commented out lines of this file.

## What does this PR do? Document kuzzleio/sdk-javascript#390 Based on #315 Original PR on v2: #297

# [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)) ---

Aschen added 2 commits May 31, 2019 15:50

Rename folders and write redirections

a2e1128

Fix missing redirections

d237e73

Aschen self-assigned this May 31, 2019

Aschen added the v3 label May 31, 2019

Aschen mentioned this pull request Jun 3, 2019

Sdks authenticated connected props #316

Merged

scottinet suggested changes Jun 3, 2019

View reviewed changes

Aschen and others added 6 commits June 3, 2019 11:41

Fix dead links

fffa673

Fix dead links

4c82add

Update src/core/1/guides/essentials/installing-console/index.md

76cd27f

Co-Authored-By: Sébastien Cottinet <[email protected]>

Update src/core/1/guides/essentials/installing-console/index.md

72b8139

Co-Authored-By: Sébastien Cottinet <[email protected]>

Apply @scottinet comments

e139d84

Merge branch 'clean-directories' of github.com:kuzzleio/documentation…

092b2bb

… into clean-directories

benoitvidis suggested changes Jun 3, 2019

View reviewed changes

Fix link in menu

1745a92

benoitvidis approved these changes Jun 3, 2019

View reviewed changes

Fix dead links

8faa599

scottinet suggested changes Jun 3, 2019

View reviewed changes

Yoann-Abbes approved these changes Jun 3, 2019

View reviewed changes

fix(check_link): remove comments

cdee819

benoitvidis mentioned this pull request Jun 3, 2019

Remove debug #318

Merged

scottinet approved these changes Jun 4, 2019

View reviewed changes

Merge ok

1cff3d7

Aschen merged commit 3acf4f2 into 3-dev Jun 4, 2019

Aschen deleted the clean-directories branch June 4, 2019 08:17

scottinet mentioned this pull request Jun 4, 2019

Add a clustering guide #314

Merged

scottinet pushed a commit that referenced this pull request Jun 11, 2019

Sdks authenticated connected props (#316)

7bd8386

## What does this PR do? Document kuzzleio/sdk-javascript#390 Based on #315 Original PR on v2: #297

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

Normalize directories and generate redirections #315

Normalize directories and generate redirections #315

Aschen commented May 31, 2019 •

edited

Loading

scottinet left a comment

scottinet Jun 3, 2019

benoitvidis left a comment

scottinet left a comment •

edited

Loading

scottinet Jun 3, 2019


		## Overview

		Metadata can be viewed in the document's `_meta` field and contains the following properties:

Normalize directories and generate redirections #315

Normalize directories and generate redirections #315

Conversation

Aschen commented May 31, 2019 • edited Loading

What does this PR do?

How to review it

scottinet left a comment

Choose a reason for hiding this comment

scottinet Jun 3, 2019

Choose a reason for hiding this comment

benoitvidis left a comment

Choose a reason for hiding this comment

scottinet left a comment • edited Loading

Choose a reason for hiding this comment

scottinet Jun 3, 2019

Choose a reason for hiding this comment

Aschen commented May 31, 2019 •

edited

Loading

scottinet left a comment •

edited

Loading