Skip to content

Commit

Permalink
Fix dead links (#561)
Browse files Browse the repository at this point in the history
  • Loading branch information
Yoann-Abbes authored Dec 6, 2020
1 parent 63f8fd2 commit 76f3e5b
Show file tree
Hide file tree
Showing 63 changed files with 140 additions and 140 deletions.
28 changes: 14 additions & 14 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -119,20 +119,20 @@ jobs:
CYPRESS_RETRIES=5 npm run test:e2e
fi

# - stage: Tests
# name: Dead link check
# language: node_js
# node_js: 12
# if: type = pull_request OR type = push AND branch =~ /^master|[0-9]+-(dev|stable|beta)$/ OR type = cron

# before_script:
# - npm ci
# - npm run doc-prepare
# - $(npm bin)/kuzdoc iterate-repos:install --repos_path doc/framework/.repos/
# - $(npm bin)/kuzdoc framework:link -d /sdk/js/7/ -v 7
# script:
# - gem install typhoeus
# - cd doc/framework/ && HYDRA_MAX_CONCURRENCY=20 travis_retry ruby .ci/dead-links.rb -p src/sdk/js/7/
- stage: Tests
name: Dead link check
language: node_js
node_js: 12
if: type = pull_request OR type = push AND branch =~ /^master|[0-9]+-(dev|stable|beta)$/ OR type = cron

before_script:
- npm ci
- npm run doc-prepare
- $(npm bin)/kuzdoc iterate-repos:install --repos_path doc/framework/.repos/
- $(npm bin)/kuzdoc framework:link -d /sdk/js/7/ -v 7
script:
- gem install typhoeus
- cd doc/framework/ && HYDRA_MAX_CONCURRENCY=20 travis_retry ruby .ci/dead-links.rb -p src/sdk/js/7/

- stage: Deployment Doc Dev
name: Deploy next-docs.kuzzle.io
Expand Down
6 changes: 3 additions & 3 deletions doc/7/controllers/auth/login/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,16 +29,16 @@ login(strategy, [credentials], [expiresIn]);

### strategy

The name of the [authentication strategy](/core/2/guides/kuzzle-depth/authentication) used to log the user in.
The name of the [authentication strategy](/core/2/guides/main-concepts/authentication#local-strategy) used to log the user in.

Depending on the chosen authentication strategy, additional credential arguments may be required.
The API request example in this page provides the necessary arguments for the [`local` authentication plugin](https://github.com/kuzzleio/kuzzle-plugin-auth-passport-local).

Check the appropriate [authentication plugin](/core/2/plugins/guides/strategies/overview) documentation to get the list of additional arguments to provide.
Check the appropriate [authentication plugin](/core/2/guides/write-plugins/integrate-authentication-strategy) documentation to get the list of additional arguments to provide.

### expiresIn

The default value for the `expiresIn` option is defined at server level, in Kuzzle's [configuration file](/core/2/guides/essentials/configuration).
The default value for the `expiresIn` option is defined at server level, in Kuzzle's [configuration file](/core/2/guides/advanced/configuration).

## Resolves

Expand Down
4 changes: 2 additions & 2 deletions doc/7/controllers/auth/refresh-token/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,15 +40,15 @@ Additional query options

### expiresIn

The default value for the `expiresIn` option is defined at server level, in Kuzzle's [configuration file](/core/2/guides/essentials/configuration).
The default value for the `expiresIn` option is defined at server level, in Kuzzle's [configuration file](/core/2/guides/advanced/configuration).

## Resolves

The `refreshToken` action resolves to a token object with the following properties:

| Property | Type | Description |
|--------------|---------|-------------|
| `_id` | <pre>string</pre> | User unique identifier ([kuid](/core/2/guides/essentials/user-authentication#kuzzle-user-identifier-kuid)) |
| `_id` | <pre>string</pre> | User unique identifier ([kuid](/core/2/guides/main-concepts/authentication#kuzzle-user-identifier-kuid)) |
| `expiresAt` | <pre>number</pre> | Expiration timestamp in Epoch-millis format (UTC) |
| `jwt` | <pre>string</pre> | Authentication token |
| `ttl` | <pre>number</pre> | Time to live of the authentication token, in milliseconds |
Expand Down
2 changes: 1 addition & 1 deletion doc/7/controllers/bulk/delete-by-query/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Deletes documents matching the provided search query.

This is a low level route intended to bypass Kuzzle actions on document deletion, notably:
- check document write limit
- trigger [realtime notifications](/core/2/guides/essentials/real-time)
- trigger [realtime notifications](/core/2/guides/main-concepts/realtime-engine)

---

Expand Down
6 changes: 3 additions & 3 deletions doc/7/controllers/bulk/mWrite/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ description: Creates or replaces multiple documents directly into the storage en
Creates or replaces multiple documents directly into the storage engine.

This is a low level route intended to bypass Kuzzle actions on document creation, notably:
- check [document validity](/core/2/guides/essentials/data-validation),
- add [kuzzle metadata](/core/2/guides/essentials/document-metadata),
- trigger [realtime notifications](/core/2/guides/essentials/real-time) (unless asked otherwise)
- check [document validity](/core/2/guides/advanced/data-validation),
- add [kuzzle metadata](/core/2/guides/main-concepts/data-storage#kuzzle-metadata),
- trigger [realtime notifications](/core/2/guides/main-concepts/realtime-engine) (unless asked otherwise)

<br/>

Expand Down
6 changes: 3 additions & 3 deletions doc/7/controllers/bulk/write/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ description: Creates or replaces a document directly into the storage engine.
Creates or replaces a document directly into the storage engine.

This is a low level route intended to bypass Kuzzle actions on document creation, notably:
- check [document validity](/core/2/guides/essentials/data-validation),
- add [kuzzle metadata](/core/2/guides/essentials/document-metadata),
- trigger [realtime notifications](/core/2/guides/essentials/real-time) (unless asked otherwise).
- check [document validity](/core/2/guides/advanced/data-validation),
- add [kuzzle metadata](/core/2/guides/main-concepts/data-storage#kuzzle-metadata),
- trigger [realtime notifications](/core/2/guides/main-concepts/realtime-engine) (unless asked otherwise).

<br/>

Expand Down
8 changes: 4 additions & 4 deletions doc/7/controllers/collection/create/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@ description: Create a new collection

# create

Creates a new [collection](/core/2/guides/essentials/store-access-data) in the provided index.
Creates a new [collection](/core/2/guides/main-concepts/data-storage) in the provided index.

You can also provide an optional data mapping that allow you to exploit the full capabilities of our
persistent data storage layer, [ElasticSearch](https://www.elastic.co/elastic-stack) (check here the [mapping capabilities of ElasticSearch](/core/2/guides/essentials/database-mappings/)).
persistent data storage layer, [ElasticSearch](https://www.elastic.co/elastic-stack) (check here the [mapping capabilities of ElasticSearch](/core/2/guides/main-concepts/data-storage)).

This method will only update the mapping if the collection already exists.

Expand Down Expand Up @@ -38,7 +38,7 @@ create(index, collection, [definition], [options]);
### definition

An object containings:
- [collection mappings](/core/2/guides/essentials/database-mappings).
- [collection mappings](/core/2/guides/main-concepts/data-storage).
- Elasticsearch [index settings](https://www.elastic.co/guide/en/elasticsearch/reference/7.5/index-modules.html#index-modules-settings)
The mapping must have a root field `properties` that contain the mapping definition:

Expand Down Expand Up @@ -84,7 +84,7 @@ const mappings = {
};
```

More informations about database mappings [here](/core/2/guides/essentials/database-mappings).
More informations about database mappings [here](/core/2/guides/main-concepts/data-storage).

</DeprecatedBadge>

Expand Down
2 changes: 1 addition & 1 deletion doc/7/controllers/collection/get-mapping/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Additional query options
| Property | Type<br/>(default) | Description |
| ---------- | ------------------------------- | ---------------------------------------------------------------------------- |
| `queuable` | <pre>boolean</pre><br/>(`true`) | If true, queues the request during downtime, until connected to Kuzzle again |
| `includeKuzzleMeta` | <pre>boolean</pre><br/>(`true`) | If true, the returned mappings will contain [Kuzzle metadata](/core/2/guides/essentials/document-metadata/) |
| `includeKuzzleMeta` | <pre>boolean</pre><br/>(`true`) | If true, the returned mappings will contain [Kuzzle metadata](/core/2/guides/main-concepts/data-storage#kuzzle-metadata) |

## Resolves

Expand Down
6 changes: 3 additions & 3 deletions doc/7/controllers/collection/update-mapping/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ description: Update the collection mapping

__Use [collection:update](/sdk/js/7/controllers/collection/update/) instead.__

You can define the collection [dynamic mapping policy](/core/2/guides/essentials/database-mappings#dynamic-mapping-policy) by setting the `dynamic` field to the desired value.
You can define the collection [dynamic mapping policy](/core/2/guides/main-concepts/data-storage#mappings-dynamic-policy) by setting the `dynamic` field to the desired value.

You can define [collection additional metadata](/core/2/guides/essentials/database-mappings#collection-metadata) within the `_meta` root field.
You can define [collection additional metadata](/core/2/guides/main-concepts/data-storage#mappings-metadata) within the `_meta` root field.

<br/>

Expand Down Expand Up @@ -50,7 +50,7 @@ const mapping = {
};
```

More informations about database mappings [here](/core/2/guides/essentials/database-mappings).
More informations about database mappings [here](/core/2/guides/main-concepts/data-storage).

### options

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ updateSpecifications(index, collection, specifications, [options]);

An object representing the specifications.

This object must follow the [Specification Structure](/core/2/guides/essentials/data-validation):
This object must follow the [Specification Structure](/core/2/guides/advanced/data-validation):

```js
{
Expand Down
8 changes: 4 additions & 4 deletions doc/7/controllers/collection/update/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ description: Update the collection mapping

<SinceBadge version="Kuzzle 2.1.0" />

You can define the collection [dynamic mapping policy](/core/2/guides/essentials/database-mappings#dynamic-mapping-policy) by setting the `dynamic` field to the desired value.
You can define the collection [dynamic mapping policy](/core/2/guides/main-concepts/data-storage#mappings-dynamic-policy) by setting the `dynamic` field to the desired value.

You can define [collection additional metadata](/core/2/guides/essentials/database-mappings#collection-metadata) within the `_meta` root field.
You can define [collection additional metadata](/core/2/guides/main-concepts/data-storage#mappings-metadata) within the `_meta` root field.

<SinceBadge version="Kuzzle 2.2.0" />
<SinceBadge version="7.4.0" />
Expand All @@ -38,7 +38,7 @@ update(index, collection, definition);
### definition

An object containing:
- [collection mappings](/core/2/guides/essentials/database-mappings).
- [collection mappings](/core/2/guides/main-concepts/data-storage).
- Elasticsearch [index settings](https://www.elastic.co/guide/en/elasticsearch/reference/7.5/index-modules.html#index-modules-settings)


Expand Down Expand Up @@ -82,7 +82,7 @@ const mappings = {
};
```

More informations about database mappings [here](/core/2/guides/essentials/database-mappings).
More informations about database mappings [here](/core/2/guides/main-concepts/data-storage).

</DeprecatedBadge>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ validateSpecifications(index, collection, specifications, [options]);

An object representing the specifications.

This object must follow the [Specification Structure](/core/2/guides/cookbooks/datavalidation):
This object must follow the [Specification Structure](/core/2/guides/advanced/data-validation):

```js
{
Expand Down
6 changes: 3 additions & 3 deletions doc/7/controllers/realtime/subscribe/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: Subscribe to real-time notifications

# subscribe

Subscribes by providing a set of filters: messages, document changes and, optionally, user events matching the provided filters will generate [real-time notifications](/core/2/api/essentials/notifications), sent to you in real-time by Kuzzle.
Subscribes by providing a set of filters: messages, document changes and, optionally, user events matching the provided filters will generate [real-time notifications](/core/2/api/payloads/notifications), sent to you in real-time by Kuzzle.

<br/>

Expand All @@ -21,7 +21,7 @@ subscribe(index, collection, filters, callback, [options]);
| ------------ | ------------------- | ------------------------------------------------------------- |
| `index` | <pre>string</pre> | Index name |
| `collection` | <pre>string</pre> | Collection name |
| `filters` | <pre>object</pre> | Set of filters following [Koncorde syntax](/core/2/guides/cookbooks/realtime-api) |
| `filters` | <pre>object</pre> | Set of filters following [Koncorde syntax](/core/2/api/koncorde-filters-syntax) |
| `callback` | <pre>function</pre> | Callback function to handle notifications |
| `options` | <pre>object</pre> | Query options |

Expand All @@ -39,7 +39,7 @@ Additional subscription options.
| `scope` | <pre>string</pre><br/>(`all`) | Subscribe to document entering or leaving the scope</br>Possible values: `all`, `in`, `out`, `none` |
| `users` | <pre>string</pre><br/>(`none`) | Subscribe to users entering or leaving the room</br>Possible values: `all`, `in`, `out`, `none` |
| `subscribeToSelf` | <pre>boolean</pre><br/>(`true`) | Subscribe to notifications fired by our own queries |
| `volatile` | <pre>object</pre><br/>(`null`) | subscription information, used in [user join/leave notifications](/core/2/api/essentials/volatile-data) |
| `volatile` | <pre>object</pre><br/>(`null`) | subscription information, used in [user join/leave notifications](/core/2/guides/main-concepts/api#volatile-data) |

## Resolves

Expand Down
2 changes: 1 addition & 1 deletion doc/7/controllers/security/create-api-key/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ createApiKey(userId, description, [options]);

| Property | Type | Description |
| --- | --- | --- |
| `userId` | <pre>string</pre> | User [kuid](/core/2/guides/essentials/user-authentication#kuzzle-user-identifier-kuid) |
| `userId` | <pre>string</pre> | User [kuid](/core/2/guides/main-concepts/authentication#kuzzle-user-identifier-kuid) |
| `description` | <pre>string</pre> | API key description |
| `options` | <pre>object</pre> | Additional options |

Expand Down
2 changes: 1 addition & 1 deletion doc/7/controllers/security/create-credentials/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ createCredentials(strategy, kuid, credentials, [options]);
| Property | Type | Description |
| --- | --- | --- |
| `strategy` | <pre>string</pre> | Strategy to use |
| `kuid` | <pre>string</pre> | User [kuid](/core/2/guides/essentials/user-authentication#kuzzle-user-identifier-kuid) |
| `kuid` | <pre>string</pre> | User [kuid](/core/2/guides/main-concepts/authentication#kuzzle-user-identifier-kuid) |
| `credentials` | <pre>object</pre> | New credentials |
| `options` | <pre>object</pre> | Query options |

Expand Down
2 changes: 1 addition & 1 deletion doc/7/controllers/security/create-first-admin/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ createFirstAdmin(kuid, body, [options]);

| Property | Type | Description |
| --- | --- | --- |
| `kuid` | <pre>string</pre> | Administrator [kuid](/core/2/guides/essentials/user-authentication#kuzzle-user-identifier-kuid) |
| `kuid` | <pre>string</pre> | Administrator [kuid](/core/2/guides/main-concepts/authentication#kuzzle-user-identifier-kuid) |
| `body` | <pre>object</pre> | Administrator content &amp; credentials |
| `options` | <pre>object</pre> | Query options |

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ createOrReplaceProfile(id, body, [options]);

| Property | Type | Description |
| --- | --- | --- |
| `policies` | <pre>object</pre> | [Profile content](/core/2/guides/essentials/security#defining-profiles) |
| `policies` | <pre>object</pre> | [Profile content](/core/2/guides/main-concepts/permissions#profiles) |

### options

Expand Down
2 changes: 1 addition & 1 deletion doc/7/controllers/security/create-or-replace-role/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ createOrReplaceRole(id, body, [options]);

| Property | Type | Description |
| --- | --- | --- |
| `controllers` | <pre>object</pre> | [Role definition](/core/2/guides/essentials/security#defining-roles) |
| `controllers` | <pre>object</pre> | [Role definition](/core/2/guides/main-concepts/permissions#roles) |

### options

Expand Down
2 changes: 1 addition & 1 deletion doc/7/controllers/security/create-profile/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ createProfile(id, profile, [options]);
| Property | Type | Description |
|--- |--- |--- |
| `id` | <pre>string</pre> | Profile identifier |
| `profile` | <pre>object</pre> | [Profile definition content](/core/2/guides/essentials/security#defining-profiles) |
| `profile` | <pre>object</pre> | [Profile definition content](/core/2/guides/main-concepts/permissions#profiles) |
| `options` | <pre>object</pre> | Query options |

### options
Expand Down
4 changes: 2 additions & 2 deletions doc/7/controllers/security/create-restricted-user/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ description: Creates a new user in Kuzzle, with a preset list of security profil
Creates a new user in Kuzzle, with a preset list of security profiles.

The list of security profiles attributed to restricted users is fixed, and must be configured in the
[Kuzzle configuration file](/core/2/guides/essentials/configuration).
[Kuzzle configuration file](/core/2/guides/advanced/configuration).

This method allows users with limited rights to create other accounts, but blocks them from creating accounts with unwanted privileges (e.g. an anonymous user creating his own account).

Expand All @@ -25,7 +25,7 @@ createRestrictedUser(body, [kuid], [options]);
| Property | Type | Description |
|--- |--- |--- |
| `body` | <pre>object</pre> | User content &amp; credentials |
| `kuid` | <pre>string</pre> | User [kuid](/core/2/guides/essentials/user-authentication#kuzzle-user-identifier-kuid). If not provided, a random kuid is automatically generated |
| `kuid` | <pre>string</pre> | User [kuid](/core/2/guides/main-concepts/authentication#kuzzle-user-identifier-kuid). If not provided, a random kuid is automatically generated |
| `options` | <pre>object</pre> | Query options |


Expand Down
2 changes: 1 addition & 1 deletion doc/7/controllers/security/create-role/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ createRole(id, body, [options]);

| Property | Type | Description |
| --- | --- | --- |
| `controllers` | <pre>object</pre> | [Role definition](/core/2/guides/essentials/security#defining-roles) |
| `controllers` | <pre>object</pre> | [Role definition](/core/2/guides/main-concepts/permissions#roles) |

### options

Expand Down
2 changes: 1 addition & 1 deletion doc/7/controllers/security/create-user/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ createUser(kuid, body, [options]);

| Property | Type | Description |
|--- |--- |--- |
| `kuid` | <pre>string</pre> | User [kuid](/core/2/guides/essentials/user-authentication#kuzzle-user-identifier-kuid) |
| `kuid` | <pre>string</pre> | User [kuid](/core/2/guides/main-concepts/authentication#kuzzle-user-identifier-kuid) |
| `body` | <pre>object</pre> | User content &amp; credentials |
| `options` | <pre>object</pre> | Query options |

Expand Down
2 changes: 1 addition & 1 deletion doc/7/controllers/security/delete-api-key/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ deleteApiKey(userId, id, [options]);

| Property | Type | Description |
| --- | --- | --- |
| `userId` | <pre>string</pre> | User [kuid](/core/2/guides/essentials/user-authentication#kuzzle-user-identifier-kuid) |
| `userId` | <pre>string</pre> | User [kuid](/core/2/guides/main-concepts/authentication#kuzzle-user-identifier-kuid) |
| `id` | <pre>string</pre> | API key unique ID |
| `options` | <pre>object</pre> | Additional options |

Expand Down
2 changes: 1 addition & 1 deletion doc/7/controllers/security/delete-credentials/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ deleteCredentials(strategy, kuid, [options]);
| Property | Type | Description |
| --- | --- | --- |
| `strategy` | <pre>string</pre> | Strategy to use |
| `kuid` | <pre>string</pre> | User [kuid](/core/2/guides/essentials/user-authentication#kuzzle-user-identifier-kuid) |
| `kuid` | <pre>string</pre> | User [kuid](/core/2/guides/main-concepts/authentication#kuzzle-user-identifier-kuid) |
| `options` | <pre>object</pre> | Query options |

### options
Expand Down
2 changes: 1 addition & 1 deletion doc/7/controllers/security/delete-user/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ deleteUser(kuid, [options]);

| Property | Type | Description |
| --- | --- | --- |
| `kuid` | <pre>string</pre> | User [kuid](/core/2/guides/essentials/user-authentication#kuzzle-user-identifier-kuid) |
| `kuid` | <pre>string</pre> | User [kuid](/core/2/guides/main-concepts/authentication#kuzzle-user-identifier-kuid) |
| `options` | <pre>object</pre> | Query options |

### options
Expand Down
Loading

0 comments on commit 76f3e5b

Please sign in to comment.