Skip to content

Commit 3d1e7c0

Browse files
Fix getting started links (#492)
1 parent cea8c93 commit 3d1e7c0

File tree

3 files changed

+29
-31
lines changed

3 files changed

+29
-31
lines changed

doc/7/getting-started/react-native/index.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,13 @@ order: 400
99

1010
# Getting Started with Kuzzle and React Native
1111

12-
This section deals with **Kuzzle** (+ [**Javascript SDK**](/sdk/js/7/)) and **React Native**. We will create **documents** in Kuzzle and subscribe to [document notifications](/sdk/js/7/essentials/realtime-notifications/#document-messages) to develop a realtime chat.
12+
This section deals with **Kuzzle V2** (+ **Javascript SDK 7**) and **React Native**. We will create **documents** in Kuzzle and subscribe to [document notifications](/sdk/js/7/essentials/realtime-notifications#document-messages) to develop a realtime chat.
1313

1414

1515
## Requirements
1616

1717
- **Node.js** >= 12.0.0 ([install here](https://nodejs.org/en/download/))
18-
- **Running Kuzzle Stack** ([instructions here](/core/2/guides/getting-started/running-kuzzle/))
18+
- **Running Kuzzle V2 Stack** ([instructions here](/core/2/guides/getting-started/running-kuzzle))
1919
- **Expo CLI** ([install here](https://docs.expo.io/versions/v36.0.0/get-started/installation/))
2020

2121
"[Expo](https://docs.expo.io/versions/latest/) is a framework and a platform for universal React applications. It is a set of tools and services built around React Native and native platforms that help you develop, build, deploy, and quickly iterate on iOS, Android, and web apps from the same JavaScript/TypeScript codebase."
@@ -32,7 +32,7 @@ Then choose a blank project, type 'Kuzzle' and type y.
3232
Install Kuzzle's Javascript SDK:
3333
```bash
3434
cd getting-started-kuzzle
35-
npm install kuzzle-sdk
35+
npm install kuzzle-sdk@7
3636
```
3737

3838
Now, you can run your app and access it by different ways:
@@ -100,7 +100,7 @@ Like in our previous components, we'll first need to add our imports:
100100

101101
<<< ./snippets/ChatClient.js.snippet:1[js]
102102

103-
Then we will create our state that will contains our messages and call the function that will initialize our kuzzle by [establish the connection](/sdk/js/7/core-classes/kuzzle/connect/) to kuzzle and create, if they don't [exist](sdk/js/7/controllers/index/exists/), the [index](sdk/js/6/controllers/index/create/) and [collection](sdk/js/7/controllers/collection/create/) of our chat.
103+
Then we will create our state that will contains our messages and call the function that will initialize our kuzzle by [establish the connection](/sdk/js/7/core-classes/kuzzle/connect) to kuzzle and create, if they don't [exist](/sdk/js/7/controllers/index/exists), the [index](/sdk/js/7/controllers/index/create) and [collection](/sdk/js/7/controllers/collection/create) of our chat.
104104

105105
<<< ./snippets/ChatClient.js.snippet:2[js]
106106

@@ -111,10 +111,10 @@ Create the following function to fetch the messages:
111111

112112
<<< ./snippets/ChatClient.js.snippet:6[js]
113113

114-
The function `fetchMessage()` will [search](/sdk/js/7/controllers/document/search/) for the first hundred newest messages and store them in our state, before subscribing to changes in the `messages` collection.
114+
The function `fetchMessage()` will [search](/sdk/js/7/controllers/document/search) for the first hundred newest messages and store them in our state, before subscribing to changes in the `messages` collection.
115115

116116
Then, create the `subscribeMessages()` function.
117-
It will call the Kuzzle's realtime controller to allow us to [receive notifications](/sdk/js/7/controllers/realtime/subscribe/) on message creations:
117+
It will call the Kuzzle's realtime controller to allow us to [receive notifications](/sdk/js/7/controllers/realtime/subscribe) on message creations:
118118

119119
<<< ./snippets/ChatClient.js.snippet:7[js]
120120

@@ -132,7 +132,7 @@ We will need a function to create a document in Kuzzle when an user send a messa
132132

133133
<<< ./snippets/ChatClient.js.snippet:8[js]
134134

135-
This simple method will [create](/sdk/js/7/controllers/document/create/) a new message document in Kuzzle.
135+
This simple method will [create](/sdk/js/7/controllers/document/create) a new message document in Kuzzle.
136136

137137
As you can see we don't push the new message in our array on message creation.
138138

@@ -187,7 +187,7 @@ You can now add new messages to Kuzzle and receive the creation notification to
187187
Now that you're more familiar with Kuzzle, dive even deeper to learn how to leverage its full capabilities:
188188

189189
- discover what this SDK has to offer by browsing other sections of this documentation
190-
- learn more about Kuzzle [realtime engine](/core/2/guides/essentials/real-time/)
191-
- follow our guide to learn how to [manage users, and how to set up fine-grained access control](/core/2/guides/essentials/security/)
192-
- lean how to use Kuzzle [Admin Console](/core/2/guides/essentials/admin-console/) to manage your users and data
190+
- learn more about Kuzzle [realtime engine](/core/2/guides/essentials/real-time)
191+
- follow our guide to learn how to [manage users, and how to set up fine-grained access control](/core/2/guides/essentials/security)
192+
- lean how to use Kuzzle [Admin Console](/core/2/guides/essentials/admin-console) to manage your users and data
193193
- learn how to perform a [basic authentication](/sdk/js/7/controllers/auth/login)

doc/7/getting-started/react/with-redux/index.md

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,13 @@ order: 0
99

1010
# Getting Started with Kuzzle and React with Redux Saga
1111

12-
This section deals with **Kuzzle** (+ **Javascript SDK**) and **React** (with **Redux** and **Redux Saga**). We will create **documents** in Kuzzle and subscribe to [document notifications](/sdk/js/7/essentials/realtime-notifications/#document-messages) to develop a realtime chat.
12+
This section deals with **Kuzzle V2** (+ **Javascript SDK 7**) and **React** (with **Redux** and **Redux Saga**). We will create **documents** in Kuzzle and subscribe to [document notifications](/sdk/js/7/essentials/realtime-notifications#document-messages) to develop a realtime chat.
1313

1414
## Requirements
1515

1616
- **Node.js** >= 8.0.0 ([install here](https://nodejs.org/en/download/))
1717
- **Create React App** ([install here](https://github.com/facebook/create-react-app))
18-
- **Running Kuzzle Stack** ([instructions here](core/1/guides/getting-started/running-kuzzle/))
18+
- **Running Kuzzle V2 Stack** ([instructions here](/core/2/guides/getting-started/running-kuzzle))
1919

2020
## Prepare your environment
2121

@@ -24,7 +24,7 @@ Create your React app and install all the dependencies from the command line usi
2424
```bash
2525
yarn create react-app kuzzle-playground
2626
cd kuzzle-playground
27-
yarn add kuzzle-sdk redux redux-saga react-redux
27+
yarn add kuzzle-sdk@7 redux redux-saga react-redux
2828
```
2929

3030
We'll rewrite the _src/App.js_ so you can remove everything inside.
@@ -54,7 +54,7 @@ After that, create that function with the connection to Kuzzle:
5454

5555
<<< ./snippets/App.js.snippet:2[js]
5656

57-
Then we will [establish the connection](/sdk/js/7/core-classes/kuzzle/connect/) to kuzzle and create, if they don't [exist](sdk/js/6/controllers/index/exists/), the [index](sdk/js/6/controllers/index/create/) and [collection](sdk/js/6/controllers/collection/create/) for our chat.
57+
Then we will [establish the connection](/sdk/js/7/core-classes/kuzzle/connect) to kuzzle and create, if they don't [exist](/sdk/js/7/controllers/index/exists), the [index](/sdk/js/7/controllers/index/create) and [collection](/sdk/js/7/controllers/collection/create) for our chat.
5858

5959
Add the following lines to the `_initialize` function:
6060

@@ -116,7 +116,7 @@ We can now display the messages stored in Kuzzle. In the next part, we'll see ho
116116

117117
## Send messages
118118

119-
We need to write a simple method that will [create](/sdk/js/7/controllers/document/create/) a new message document in Kuzzle.
119+
We need to write a simple method that will [create](/sdk/js/7/controllers/document/create) a new message document in Kuzzle.
120120
Add the following function in your `app` class in the_src/App.js_ file:
121121

122122
<<< ./snippets/App.js.snippet:10[js]
@@ -130,7 +130,7 @@ Let's add it in the _src/state/sagas.js_ file:
130130

131131
As you can see we don't push the new message in our state on message creation.
132132
Now, we need to subscribe to changes made on the collection containing our messages.
133-
So let's create our `_subscribeToNewMessages()` function in the `app` class in _src/App.js_ file. It will call Kuzzle's realtime controller to allow us to [receive notifications](/sdk/js/7/controllers/realtime/subscribe/) on message creations:
133+
So let's create our `_subscribeToNewMessages()` function in the `app` class in _src/App.js_ file. It will call Kuzzle's realtime controller to allow us to [receive notifications](/sdk/js/7/controllers/realtime/subscribe) on message creations:
134134

135135
<<< ./snippets/App.js.snippet:8[js]
136136

@@ -164,8 +164,6 @@ You can now add new messages to Kuzzle and receive the notification of the creat
164164
Now that you're more familiar with Kuzzle with React, you can:
165165

166166
- discover what this SDK has to offer by browsing other sections of this documentation
167-
- learn how to use [Koncorde](/core/2/guides/cookbooks/realtime-api/introduction/) to create incredibly fine-grained and blazing-fast subscriptions
168-
- learn more about Kuzzle [realtime engine](/core/2/guides/essentials/real-time/)
169-
- follow our guide to learn how to [manage users, and how to set up fine-grained access control](/guide/1/essentials/security/)
170-
171-
To help you starting a new project with Kuzzle and React, you can start with the [**Kuzzle, React and Redux boilerplate**](https://github.com/kuzzleio/kuzzle-react-redux-boilerplate).
167+
- learn how to use [Koncorde](/core/2/guides/cookbooks/realtime-api/introduction) to create incredibly fine-grained and blazing-fast subscriptions
168+
- learn more about Kuzzle [realtime engine](/core/2/guides/essentials/real-time)
169+
- follow our guide to learn how to [manage users, and how to set up fine-grained access control](/core/2/guides/essentials/security)

doc/7/getting-started/vuejs/standalone/index.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,14 @@ order: 0
99

1010
# Getting Started with Kuzzle and VueJS
1111

12-
This section deals with **Kuzzle** (+ **Javascript SDK**) and **VueJS**. We will create **documents** in Kuzzle and subscribe to [document notifications](/sdk/js/7/essentials/realtime-notifications/#document-messages) to develop a realtime chat.
12+
This section deals with **Kuzzle V2** (+ **Javascript SDK 7**) and **VueJS**. We will create **documents** in Kuzzle and subscribe to [document notifications](/sdk/js/7/essentials/realtime-notifications#document-messages) to develop a realtime chat.
1313

1414

1515
## Requirements
1616

1717
- **Node.js** >= 8.0.0 ([install here](https://nodejs.org/en/download/))
1818
- **Vue CLI** ([install here](https://cli.vuejs.org/guide/installation.html))
19-
- **Running Kuzzle Stack** ([instructions here](/core/2/guides/getting-started/running-kuzzle/))
19+
- **Running Kuzzle V2 Stack** ([instructions here](/core/2/guides/getting-started/running-kuzzle))
2020

2121
## Prepare your environment
2222

@@ -29,7 +29,7 @@ vue create kuzzle-playground
2929
Install Kuzzle's Javascript SDK:
3030
```bash
3131
cd kuzzle-playground
32-
npm install kuzzle-sdk
32+
npm install kuzzle-sdk@7
3333
```
3434

3535
In the _App.vue_ file, you should remove the tag, the import and the component registration of the `HelloWorld` component, we won't use it.
@@ -46,7 +46,7 @@ We need to import our Kuzzle SDK instance, so just add the following line in you
4646

4747
<<< ./snippets/App.vue.snippet:3[js]
4848

49-
Then we will [establish the connection](/sdk/js/7/core-classes/kuzzle/connect/) to kuzzle and create, if they don't [exist](sdk/js/6/controllers/index/exists/), the [index](sdk/js/6/controllers/index/create/) and [collection](sdk/js/6/controllers/collection/create/) of our chat.
49+
Then we will [establish the connection](/sdk/js/7/core-classes/kuzzle/connect) to kuzzle and create, if they don't [exist](/sdk/js/7/controllers/index/exists/), the [index](/sdk/js/7/controllers/index/create) and [collection](/sdk/js/7/controllers/collection/create) of our chat.
5050
Add the following `valid()` method in the export of the `<script>` tag of your _App.vue_ file:
5151

5252
<<< ./snippets/App.vue.snippet:2[js]
@@ -71,7 +71,7 @@ Then, create the following functions to fetch and display the messages:
7171

7272
<<< ./snippets/App.vue.snippet:6[js]
7373

74-
The function `fetchMessage()` will [search](/sdk/js/7/controllers/document/search/) for the first hundred newest messages and store them in our array, before subscribing to changes in the `messages` collection. We called it in the `valid()` function we created above.
74+
The function `fetchMessage()` will [search](/sdk/js/7/controllers/document/search) for the first hundred newest messages and store them in our array, before subscribing to changes in the `messages` collection. We called it in the `valid()` function we created above.
7575

7676
<<< ./snippets/App.vue.snippet:7[js]
7777

@@ -87,7 +87,7 @@ We can now display the messages stored in Kuzzle. All there is to do is to creat
8787

8888
## Send messages
8989

90-
We need to write a simple method that will [create](/sdk/js/7/controllers/document/create/) a new message document in Kuzzle.
90+
We need to write a simple method that will [create](/sdk/js/7/controllers/document/create) a new message document in Kuzzle.
9191

9292
<<< ./snippets/App.vue.snippet:10[js]
9393

@@ -96,7 +96,7 @@ As you can see we don't push the new message in our array on message creation.
9696
Indeed, we will receive notifications from Kuzzle each time we modify our message collection (even if it is a message creation on our part) that we will use to add the messages in our array.
9797

9898
Now, we need to subscribe to the collection that contains our messages.
99-
So let's create our `subscribeMessages()` action. It will call the Kuzzle's realtime controller to allow us to [receive notifications](/sdk/js/7/controllers/realtime/subscribe/) on message creations:
99+
So let's create our `subscribeMessages()` action. It will call the Kuzzle's realtime controller to allow us to [receive notifications](/sdk/js/7/controllers/realtime/subscribe) on message creations:
100100

101101
<<< ./snippets/App.vue.snippet:11[js]
102102

@@ -115,7 +115,7 @@ You can now add new messages to Kuzzle and receive the creation notification to
115115
Now that you're more familiar with Kuzzle, dive even deeper to learn how to leverage its full capabilities:
116116

117117
- discover what this SDK has to offer by browsing other sections of this documentation
118-
- learn more about Kuzzle [realtime engine](/core/2/guides/essentials/real-time/)
119-
- follow our guide to learn how to [manage users, and how to set up fine-grained access control](/core/2/guides/essentials/security/)
120-
- lean how to use Kuzzle [Admin Console](/core/2/guides/essentials/admin-console/) to manage your users and data
118+
- learn more about Kuzzle [realtime engine](/core/2/guides/essentials/real-time)
119+
- follow our guide to learn how to [manage users, and how to set up fine-grained access control](/core/2/guides/essentials/security)
120+
- lean how to use Kuzzle [Admin Console](/core/2/guides/essentials/admin-console) to manage your users and data
121121
- learn how to perform a [basic authentication](/sdk/js/7/controllers/auth/login)

0 commit comments

Comments
 (0)