Skip to content

Commit 1630d13

Browse files
meili-bors[bot]meili-botbidoubiwa
authored
Merge #479
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]>
2 parents 00acb01 + 0878012 commit 1630d13

File tree

12 files changed

+84
-85
lines changed

12 files changed

+84
-85
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ First of all, thank you for contributing to Meilisearch! The goal of this docume
1212
## Assumptions
1313

1414
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.**
1717

1818
## How to Contribute
1919

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@
1010

1111
<h4 align="center">
1212
<a href="https://github.com/meilisearch/meilisearch">Meilisearch</a> |
13-
<a href="https://docs.meilisearch.com">Documentation</a> |
13+
<a href="https://www.meilisearch.com/docs">Documentation</a> |
1414
<a href="https://discord.meilisearch.com">Discord</a> |
1515
<a href="https://roadmap.meilisearch.com/tabs/1-under-consideration">Roadmap</a> |
1616
<a href="https://www.meilisearch.com">Website</a> |
17-
<a href="https://docs.meilisearch.com/faq">FAQ</a>
17+
<a href="https://www.meilisearch.com/docs/faq">FAQ</a>
1818
</h4>
1919

2020
<p align="center">
@@ -44,7 +44,7 @@
4444

4545
This readme contains all the documentation you need to start using this Meilisearch SDK.
4646

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).
4848

4949
## 🔧 Installation
5050

@@ -71,7 +71,7 @@ Using this crate is possible without [serde](https://crates.io/crates/serde), bu
7171

7272
This crate requires a Meilisearch server to run.
7373

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).
7575

7676
For example,using the `curl` command in [your Terminal](https://itconnect.uw.edu/learn/workshops/online-tutorials/web-publishing/what-is-a-terminal/):
7777

@@ -121,7 +121,7 @@ fn main() { block_on(async move {
121121
})}
122122
```
123123

124-
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).
125125

126126
#### Basic Search <!-- omit in TOC -->
127127

@@ -199,7 +199,7 @@ client.index("movies_4").set_filterable_attributes(&filterable_attributes).await
199199

200200
You only need to perform this operation once.
201201

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://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).
203203

204204
Then, you can perform the search:
205205

README.tpl

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@
1010

1111
<h4 align="center">
1212
<a href="https://github.com/meilisearch/meilisearch">Meilisearch</a> |
13-
<a href="https://docs.meilisearch.com">Documentation</a> |
13+
<a href="https://www.meilisearch.com/docs">Documentation</a> |
1414
<a href="https://discord.meilisearch.com">Discord</a> |
1515
<a href="https://roadmap.meilisearch.com/tabs/1-under-consideration">Roadmap</a> |
1616
<a href="https://www.meilisearch.com">Website</a> |
17-
<a href="https://docs.meilisearch.com/faq">FAQ</a>
17+
<a href="https://www.meilisearch.com/docs/faq">FAQ</a>
1818
</h4>
1919

2020
<p align="center">
@@ -44,7 +44,7 @@
4444

4545
This readme contains all the documentation you need to start using this Meilisearch SDK.
4646

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).
4848

4949
## 🔧 Installation
5050

@@ -71,7 +71,7 @@ Using this crate is possible without [serde](https://crates.io/crates/serde), bu
7171

7272
This crate requires a Meilisearch server to run.
7373

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).
7575

7676
For example,using the `curl` command in [your Terminal](https://itconnect.uw.edu/learn/workshops/online-tutorials/web-publishing/what-is-a-terminal/):
7777

examples/settings.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ async fn main() {
2323
.expect("An error happened with the index creation.");
2424

2525
// And now we can update the settings!
26-
// You can read more about the available options here: https://docs.meilisearch.com/learn/configuration/settings.html#index-settings
26+
// You can read more about the available options here: https://www.meilisearch.com/docs/learn/configuration/settings#index-settings
2727
let settings: Settings = Settings::new()
2828
.with_searchable_attributes(["name", "title"])
2929
.with_filterable_attributes(["created_at"]);

src/client.rs

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ impl Client {
3131
///
3232
/// Don't put a '/' at the end of the host.
3333
///
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).
3535
///
3636
/// # Example
3737
///
@@ -549,7 +549,7 @@ impl Client {
549549

550550
/// Get the API [Keys](Key) from Meilisearch with parameters.
551551
///
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).
553553
///
554554
/// # Example
555555
///
@@ -583,7 +583,7 @@ impl Client {
583583

584584
/// Get the API [Keys](Key) from Meilisearch.
585585
///
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).
587587
///
588588
/// # Example
589589
///
@@ -614,7 +614,7 @@ impl Client {
614614

615615
/// Get one API [Key] from Meilisearch.
616616
///
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).
618618
///
619619
/// # Example
620620
///
@@ -646,7 +646,7 @@ impl Client {
646646

647647
/// Delete an API [Key] from Meilisearch.
648648
///
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).
650650
///
651651
/// # Example
652652
///
@@ -681,7 +681,7 @@ impl Client {
681681

682682
/// Create an API [Key] in Meilisearch.
683683
///
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).
685685
///
686686
/// # Example
687687
///
@@ -718,7 +718,7 @@ impl Client {
718718

719719
/// Update an API [Key] in Meilisearch.
720720
///
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).
722722
///
723723
/// # Example
724724
///

src/dumps.rs

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,7 @@
1111
//! - During a dump import, all indexes contained in the indicated `.dump` file are imported along with their associated documents and [settings](crate::settings::Settings).
1212
//! Any existing [index](crate::indexes::Index) with the same uid as an index in the dump file will be overwritten.
1313
//!
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.
1615
//!
1716
//! # Example
1817
//!
@@ -46,7 +45,7 @@ use crate::{client::Client, errors::Error, request::*, task_info::TaskInfo};
4645
impl Client {
4746
/// Triggers a dump creation process.
4847
///
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).
5049
/// If the dumps directory does not exist yet, it will be created.
5150
///
5251
/// # Example

src/errors.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ pub struct MeilisearchError {
7373
#[serde(rename = "message")]
7474
pub error_message: String,
7575
/// The error code of the error. Officially documented at
76-
/// <https://docs.meilisearch.com/errors>.
76+
/// <https://www.meilisearch.com/docs/reference/errors/error_codes>.
7777
#[serde(rename = "code")]
7878
pub error_code: ErrorCode,
7979
/// The type of error (invalid request, internal error, or authentication error)
@@ -115,7 +115,7 @@ impl std::fmt::Display for ErrorType {
115115

116116
/// The error code.
117117
///
118-
/// Officially documented at <https://docs.meilisearch.com/errors>.
118+
/// Officially documented at <https://www.meilisearch.com/docs/reference/errors/error_codes>.
119119
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
120120
#[serde(rename_all = "snake_case")]
121121
#[non_exhaustive]

src/indexes.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ use serde::{de::DeserializeOwned, Deserialize, Serialize};
1111
use std::{collections::HashMap, fmt::Display, time::Duration};
1212
use time::OffsetDateTime;
1313

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).
1515
///
1616
/// # Example
1717
///
@@ -996,7 +996,7 @@ impl Index {
996996
Ok(self.primary_key.as_deref())
997997
}
998998

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).
10001000
///
10011001
/// # Example
10021002
///

0 commit comments

Comments
 (0)