You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
479: Update documentation links to the new documentation website r=bidoubiwa a=meili-bot
_This PR is auto-generated._
The automated script generated this PR, it updates all the documentation link to the new documentation.
While the domain name and path to the documentation is updated, most of the links require additional changes.
For example: https://github.com/meilisearch/meilisearch-js/pull/1507/files
Additionally, this script only covers the README.md and the CONTRIBUTING.md. It is possible that documentation links that should be updated are present in order files as well. Please check.
Please ensure every new link points to the relevant page.
Related to meilisearch/integration-guides#257
Co-authored-by: meili-bot <[email protected]>
Co-authored-by: cvermand <[email protected]>
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,8 +12,8 @@ First of all, thank you for contributing to Meilisearch! The goal of this docume
12
12
## Assumptions
13
13
14
14
1.**You're familiar with [GitHub](https://github.com) and the [Pull Request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests)(PR) workflow.**
15
-
2.**You've read the Meilisearch [documentation](https://docs.meilisearch.com) and the [README](/README.md).**
16
-
3.**You know about the [Meilisearch community](https://docs.meilisearch.com/learn/what_is_meilisearch/contact.html). Please use this for help.**
15
+
2.**You've read the Meilisearch [documentation](https://www.meilisearch.com/docs) and the [README](/README.md).**
16
+
3.**You know about the [Meilisearch community](https://discord.com/invite/meilisearch). Please use this for help.**
This readme contains all the documentation you need to start using this Meilisearch SDK.
46
46
47
-
For general information on how to use Meilisearch—such as our API reference, tutorials, guides, and in-depth articles—refer to our [main documentation website](https://docs.meilisearch.com/).
47
+
For general information on how to use Meilisearch—such as our API reference, tutorials, guides, and in-depth articles—refer to our [main documentation website](https://www.meilisearch.com/docs).
48
48
49
49
## 🔧 Installation
50
50
@@ -71,7 +71,7 @@ Using this crate is possible without [serde](https://crates.io/crates/serde), bu
71
71
72
72
This crate requires a Meilisearch server to run.
73
73
74
-
There are many easy ways to [download and run a Meilisearch instance](https://docs.meilisearch.com/reference/features/installation.html#download-and-launch).
74
+
There are many easy ways to [download and run a Meilisearch instance](https://www.meilisearch.com/docs/learn/getting_started/installation).
75
75
76
76
For example,using the `curl` command in [your Terminal](https://itconnect.uw.edu/learn/workshops/online-tutorials/web-publishing/what-is-a-terminal/):
With the `uid`, you can check the status (`enqueued`, `processing`, `succeeded` or `failed`) of your documents addition using the [task](https://docs.meilisearch.com/reference/api/tasks.html#get-task).
124
+
With the `uid`, you can check the status (`enqueued`, `processing`, `succeeded` or `failed`) of your documents addition using the [task](https://www.meilisearch.com/docs/reference/api/tasks#get-task).
Note that Meilisearch will rebuild your index whenever you update `filterableAttributes`. Depending on the size of your dataset, this might take time. You can track the process using the [tasks](https://docs.meilisearch.com/reference/api/tasks.html#get-task)).
202
+
Note that Meilisearch will rebuild your index whenever you update `filterableAttributes`. Depending on the size of your dataset, this might take time. You can track the process using the [tasks](https://www.meilisearch.com/docs/reference/api/tasks#get-task).
This readme contains all the documentation you need to start using this Meilisearch SDK.
46
46
47
-
For general information on how to use Meilisearch—such as our API reference, tutorials, guides, and in-depth articles—refer to our [main documentation website](https://docs.meilisearch.com/).
47
+
For general information on how to use Meilisearch—such as our API reference, tutorials, guides, and in-depth articles—refer to our [main documentation website](https://www.meilisearch.com/docs).
48
48
49
49
## 🔧 Installation
50
50
@@ -71,7 +71,7 @@ Using this crate is possible without [serde](https://crates.io/crates/serde), bu
71
71
72
72
This crate requires a Meilisearch server to run.
73
73
74
-
There are many easy ways to [download and run a Meilisearch instance](https://docs.meilisearch.com/reference/features/installation.html#download-and-launch).
74
+
There are many easy ways to [download and run a Meilisearch instance](https://www.meilisearch.com/docs/learn/getting_started/installation).
75
75
76
76
For example,using the `curl` command in [your Terminal](https://itconnect.uw.edu/learn/workshops/online-tutorials/web-publishing/what-is-a-terminal/):
Copy file name to clipboardExpand all lines: src/client.rs
+7-7Lines changed: 7 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -31,7 +31,7 @@ impl Client {
31
31
///
32
32
/// Don't put a '/' at the end of the host.
33
33
///
34
-
/// In production mode, see [the documentation about authentication](https://docs.meilisearch.com/reference/features/authentication.html#authentication).
34
+
/// In production mode, see [the documentation about authentication](https://www.meilisearch.com/docs/learn/security/master_api_keys#authentication).
35
35
///
36
36
/// # Example
37
37
///
@@ -549,7 +549,7 @@ impl Client {
549
549
550
550
/// Get the API [Keys](Key) from Meilisearch with parameters.
551
551
///
552
-
/// See [`Client::create_key`], [`Client::get_key`], and the [meilisearch documentation](https://docs.meilisearch.com/reference/api/keys.html#get-all-keys).
552
+
/// See [`Client::create_key`], [`Client::get_key`], and the [meilisearch documentation](https://www.meilisearch.com/docs/reference/api/keys#get-all-keys).
553
553
///
554
554
/// # Example
555
555
///
@@ -583,7 +583,7 @@ impl Client {
583
583
584
584
/// Get the API [Keys](Key) from Meilisearch.
585
585
///
586
-
/// See [`Client::create_key`], [`Client::get_key`], and the [meilisearch documentation](https://docs.meilisearch.com/reference/api/keys.html#get-all-keys).
586
+
/// See [`Client::create_key`], [`Client::get_key`], and the [meilisearch documentation](https://www.meilisearch.com/docs/reference/api/keys#get-all-keys).
587
587
///
588
588
/// # Example
589
589
///
@@ -614,7 +614,7 @@ impl Client {
614
614
615
615
/// Get one API [Key] from Meilisearch.
616
616
///
617
-
/// See also [`Client::create_key`], [`Client::get_keys`], and the [meilisearch documentation](https://docs.meilisearch.com/reference/api/keys.html#get-one-key).
617
+
/// See also [`Client::create_key`], [`Client::get_keys`], and the [meilisearch documentation](https://www.meilisearch.com/docs/reference/api/keys#get-one-key).
618
618
///
619
619
/// # Example
620
620
///
@@ -646,7 +646,7 @@ impl Client {
646
646
647
647
/// Delete an API [Key] from Meilisearch.
648
648
///
649
-
/// See also [`Client::create_key`], [`Client::update_key`], [`Client::get_key`], and the [meilisearch documentation](https://docs.meilisearch.com/reference/api/keys.html#delete-a-key).
649
+
/// See also [`Client::create_key`], [`Client::update_key`], [`Client::get_key`], and the [meilisearch documentation](https://www.meilisearch.com/docs/reference/api/keys#delete-a-key).
650
650
///
651
651
/// # Example
652
652
///
@@ -681,7 +681,7 @@ impl Client {
681
681
682
682
/// Create an API [Key] in Meilisearch.
683
683
///
684
-
/// See also [`Client::update_key`], [`Client::delete_key`], [`Client::get_key`], and the [meilisearch documentation](https://docs.meilisearch.com/reference/api/keys.html#create-a-key).
684
+
/// See also [`Client::update_key`], [`Client::delete_key`], [`Client::get_key`], and the [meilisearch documentation](https://www.meilisearch.com/docs/reference/api/keys#create-a-key).
685
685
///
686
686
/// # Example
687
687
///
@@ -718,7 +718,7 @@ impl Client {
718
718
719
719
/// Update an API [Key] in Meilisearch.
720
720
///
721
-
/// See also [`Client::create_key`], [`Client::delete_key`], [`Client::get_key`], and the [meilisearch documentation](https://docs.meilisearch.com/reference/api/keys.html#update-a-key).
721
+
/// See also [`Client::create_key`], [`Client::delete_key`], [`Client::get_key`], and the [meilisearch documentation](https://www.meilisearch.com/docs/reference/api/keys#update-a-key).
Copy file name to clipboardExpand all lines: src/dumps.rs
+2-3Lines changed: 2 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -11,8 +11,7 @@
11
11
//! - During a dump import, all indexes contained in the indicated `.dump` file are imported along with their associated documents and [settings](crate::settings::Settings).
12
12
//! Any existing [index](crate::indexes::Index) with the same uid as an index in the dump file will be overwritten.
13
13
//!
14
-
//! - Dump imports are [performed at launch](https://docs.meilisearch.com/reference/features/configuration.html#import-dump) using an option.
15
-
//! [Batch size](https://docs.meilisearch.com/reference/features/configuration.html#dump-batch-size) can also be set at this time.
14
+
//! - Dump imports are [performed at launch](https://www.meilisearch.com/docs/learn/configuration/instance_options#import-dump) using an option.
16
15
//!
17
16
//! # Example
18
17
//!
@@ -46,7 +45,7 @@ use crate::{client::Client, errors::Error, request::*, task_info::TaskInfo};
46
45
implClient{
47
46
/// Triggers a dump creation process.
48
47
///
49
-
/// Once the process is complete, a dump is created in the [dumps directory](https://docs.meilisearch.com/reference/features/configuration.html#dumps-destination).
48
+
/// Once the process is complete, a dump is created in the [dumps directory](https://www.meilisearch.com/docs/learn/configuration/instance_options#dump-directory).
50
49
/// If the dumps directory does not exist yet, it will be created.
Copy file name to clipboardExpand all lines: src/indexes.rs
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@ use serde::{de::DeserializeOwned, Deserialize, Serialize};
11
11
use std::{collections::HashMap, fmt::Display, time::Duration};
12
12
use time::OffsetDateTime;
13
13
14
-
/// A Meilisearch [index](https://docs.meilisearch.com/learn/core_concepts/indexes.html).
14
+
/// A Meilisearch [index](https://www.meilisearch.com/docs/learn/core_concepts/indexes).
15
15
///
16
16
/// # Example
17
17
///
@@ -996,7 +996,7 @@ impl Index {
996
996
Ok(self.primary_key.as_deref())
997
997
}
998
998
999
-
/// Get a [Task] from a specific [Index] to keep track of [asynchronous operations](https://docs.meilisearch.com/learn/advanced/asynchronous_operations.html).
999
+
/// Get a [Task] from a specific [Index] to keep track of [asynchronous operations](https://www.meilisearch.com/docs/learn/advanced/asynchronous_operations).
0 commit comments