From 8a959da1201295d812d7b454ba90080f81f8d1f4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar?= Date: Wed, 26 Jan 2022 17:43:16 +0100 Subject: [PATCH] Update MeiliSearch into Meilisearch everywhere --- .github/ISSUE_TEMPLATE/bug_report.md | 4 ++-- .github/ISSUE_TEMPLATE/config.yml | 2 +- .github/is-latest-release.sh | 2 +- .github/workflows/README.md | 2 +- SECURITY.md | 8 ++++---- download-latest.sh | 16 ++++++++-------- meilisearch-http/Cargo.toml | 2 +- meilisearch-http/src/analytics/mod.rs | 8 ++++---- .../src/analytics/segment_analytics.rs | 2 +- meilisearch-http/src/main.rs | 4 ++-- meilisearch-http/src/routes/mod.rs | 4 ++-- meilisearch-lib/src/index/search.rs | 2 +- .../src/index_controller/versioning/error.rs | 6 +++--- .../src/index_controller/versioning/mod.rs | 4 ++-- meilisearch-lib/src/tasks/task.rs | 4 ++-- meilisearch-lib/src/tasks/task_store/store.rs | 2 +- 16 files changed, 36 insertions(+), 36 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index cea573edf..4ce2db180 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -23,8 +23,8 @@ A clear and concise description of what you expected to happen. **Screenshots** If applicable, add screenshots to help explain your problem. -**MeiliSearch version:** [e.g. v0.20.0] +**Meilisearch version:** [e.g. v0.20.0] **Additional context** Additional information that may be relevant to the issue. -[e.g. architecture, device, OS, browser] \ No newline at end of file +[e.g. architecture, device, OS, browser] diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index c48a05c91..4997861fb 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -6,5 +6,5 @@ contact_links: url: https://github.com/meilisearch/documentation/issues/new about: For documentation issues, open an issue or a PR in the documentation repository - name: Support questions & other - url: https://github.com/meilisearch/MeiliSearch/discussions/new + url: https://github.com/meilisearch/meilisearch/discussions/new about: For any other question, open a discussion in this repository diff --git a/.github/is-latest-release.sh b/.github/is-latest-release.sh index b30c6138b..77e3ad9a0 100644 --- a/.github/is-latest-release.sh +++ b/.github/is-latest-release.sh @@ -74,7 +74,7 @@ semverLT() { # Returns the tag of the latest stable release (in terms of semver and not of release date) get_latest() { temp_file='temp_file' # temp_file needed because the grep would start before the download is over - curl -s 'https://api.github.com/repos/meilisearch/MeiliSearch/releases' > "$temp_file" + curl -s 'https://api.github.com/repos/meilisearch/meiliSearch/releases' > "$temp_file" releases=$(cat "$temp_file" | \ grep -E "tag_name|draft|prerelease" \ | tr -d ',"' | cut -d ':' -f2 | tr -d ' ') diff --git a/.github/workflows/README.md b/.github/workflows/README.md index 32c32c7d6..ffb401a6c 100644 --- a/.github/workflows/README.md +++ b/.github/workflows/README.md @@ -1,4 +1,4 @@ -# GitHub Actions Workflow for MeiliSearch +# GitHub Actions Workflow for Meilisearch > **Note:** diff --git a/SECURITY.md b/SECURITY.md index 28775c485..63bc15a40 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -1,16 +1,16 @@ # Security -MeiliSearch takes the security of our software products and services seriously. +Meilisearch takes the security of our software products and services seriously. -If you believe you have found a security vulnerability in any MeiliSearch-owned repository, please report it to us as described below. +If you believe you have found a security vulnerability in any Meilisearch-owned repository, please report it to us as described below. ## Suported versions -As long as we are pre-v1.0, only the latest version of MeiliSearch will be supported with security updates. +As long as we are pre-v1.0, only the latest version of Meilisearch will be supported with security updates. ## Reporting security issues -⚠️ Please do not report security vulnerabilities through public GitHub issues. ⚠️ +⚠️ Please do not report security vulnerabilities through public GitHub issues. ⚠️ Instead, please kindly email us at security@meilisearch.com diff --git a/download-latest.sh b/download-latest.sh index 5001103e6..926f5f630 100644 --- a/download-latest.sh +++ b/download-latest.sh @@ -74,9 +74,9 @@ get_latest() { temp_file='temp_file' # temp_file needed because the grep would start before the download is over if [ -z "$GITHUB_PAT" ]; then - curl -s 'https://api.github.com/repos/meilisearch/MeiliSearch/releases' > "$temp_file" || return 1 + curl -s 'https://api.github.com/repos/meilisearch/Meilisearch/releases' > "$temp_file" || return 1 else - curl -H "Authorization: token $GITHUB_PAT" -s 'https://api.github.com/repos/meilisearch/MeiliSearch/releases' > "$temp_file" || return 1 + curl -H "Authorization: token $GITHUB_PAT" -s 'https://api.github.com/repos/meilisearch/Meilisearch/releases' > "$temp_file" || return 1 fi releases=$(cat "$temp_file" | \ @@ -161,7 +161,7 @@ get_archi() { } success_usage() { - printf "$GREEN%s\n$DEFAULT" "MeiliSearch $latest binary successfully downloaded as '$binary_name' file." + printf "$GREEN%s\n$DEFAULT" "Meilisearch $latest binary successfully downloaded as '$binary_name' file." echo '' echo 'Run it:' echo ' $ ./meilisearch' @@ -170,7 +170,7 @@ success_usage() { } failure_usage() { - printf "$RED%s\n$DEFAULT" 'ERROR: MeiliSearch binary is not available for your OS distribution or your architecture yet.' + printf "$RED%s\n$DEFAULT" 'ERROR: Meilisearch binary is not available for your OS distribution or your architecture yet.' echo '' echo 'However, you can easily compile the binary from the source files.' echo 'Follow the steps at the page ("Source" tab): https://docs.meilisearch.com/learn/getting_started/installation.html' @@ -181,8 +181,8 @@ latest="$(get_latest)" if [ "$latest" = '' ]; then echo '' - echo 'Impossible to get the latest stable version of MeiliSearch.' - echo 'Please let us know about this issue: https://github.com/meilisearch/MeiliSearch/issues/new/choose' + echo 'Impossible to get the latest stable version of Meilisearch.' + echo 'Please let us know about this issue: https://github.com/meilisearch/Meilisearch/issues/new/choose' exit 1 fi @@ -196,7 +196,7 @@ if ! get_archi; then exit 1 fi -echo "Downloading MeiliSearch binary $latest for $os, architecture $archi..." +echo "Downloading Meilisearch binary $latest for $os, architecture $archi..." case "$os" in 'windows') release_file="meilisearch-$os-$archi.exe" @@ -208,7 +208,7 @@ case "$os" in binary_name='meilisearch' esac -link="https://github.com/meilisearch/MeiliSearch/releases/download/$latest/$release_file" +link="https://github.com/meilisearch/Meilisearch/releases/download/$latest/$release_file" curl -OL "$link" mv "$release_file" "$binary_name" chmod 744 "$binary_name" diff --git a/meilisearch-http/Cargo.toml b/meilisearch-http/Cargo.toml index d1f2ead7d..fce7f3fef 100644 --- a/meilisearch-http/Cargo.toml +++ b/meilisearch-http/Cargo.toml @@ -1,6 +1,6 @@ [package] authors = ["Quentin de Quelen ", "Clément Renault "] -description = "MeiliSearch HTTP server" +description = "Meilisearch HTTP server" edition = "2021" license = "MIT" name = "meilisearch-http" diff --git a/meilisearch-http/src/analytics/mod.rs b/meilisearch-http/src/analytics/mod.rs index f777a293e..caeb7b7c0 100644 --- a/meilisearch-http/src/analytics/mod.rs +++ b/meilisearch-http/src/analytics/mod.rs @@ -29,12 +29,12 @@ pub type SegmentAnalytics = segment_analytics::SegmentAnalytics; #[cfg(all(not(debug_assertions), feature = "analytics"))] pub type SearchAggregator = segment_analytics::SearchAggregator; -/// The MeiliSearch config dir: -/// `~/.config/MeiliSearch` on *NIX or *BSD. +/// The Meilisearch config dir: +/// `~/.config/Meilisearch` on *NIX or *BSD. /// `~/Library/ApplicationSupport` on macOS. /// `%APPDATA` (= `C:\Users%USERNAME%\AppData\Roaming`) on windows. static MEILISEARCH_CONFIG_PATH: Lazy> = - Lazy::new(|| AppDirs::new(Some("MeiliSearch"), false).map(|appdir| appdir.config_dir)); + Lazy::new(|| AppDirs::new(Some("Meilisearch"), false).map(|appdir| appdir.config_dir)); fn config_user_id_path(db_path: &Path) -> Option { db_path @@ -50,7 +50,7 @@ fn config_user_id_path(db_path: &Path) -> Option { .map(|(filename, config_path)| config_path.join(filename.trim_start_matches('-'))) } -/// Look for the instance-uid in the `data.ms` or in `~/.config/MeiliSearch/path-to-db-instance-uid` +/// Look for the instance-uid in the `data.ms` or in `~/.config/Meilisearch/path-to-db-instance-uid` fn find_user_id(db_path: &Path) -> Option { fs::read_to_string(db_path.join("instance-uid")) .ok() diff --git a/meilisearch-http/src/analytics/segment_analytics.rs b/meilisearch-http/src/analytics/segment_analytics.rs index ab161c3dc..86eb8f29e 100644 --- a/meilisearch-http/src/analytics/segment_analytics.rs +++ b/meilisearch-http/src/analytics/segment_analytics.rs @@ -78,7 +78,7 @@ impl SegmentAnalytics { let user = User::UserId { user_id }; let mut batcher = AutoBatcher::new(client, Batcher::new(None), SEGMENT_API_KEY.to_string()); - // If MeiliSearch is Launched for the first time: + // If Meilisearch is Launched for the first time: // 1. Send an event Launched associated to the user `total_launch`. // 2. Batch an event Launched with the real instance-id and send it in one hour. if first_time_run { diff --git a/meilisearch-http/src/main.rs b/meilisearch-http/src/main.rs index 9ca1fecfe..cda7c2ef8 100644 --- a/meilisearch-http/src/main.rs +++ b/meilisearch-http/src/main.rs @@ -128,7 +128,7 @@ pub fn print_launch_resume(opt: &Opt, user: &str) { if !opt.no_analytics { eprintln!( " -Thank you for using MeiliSearch! +Thank you for using Meilisearch! We collect anonymized analytics to improve our product and your experience. To learn more, including how to turn off analytics, visit our dedicated documentation page: https://docs.meilisearch.com/learn/what_is_meilisearch/telemetry.html @@ -146,7 +146,7 @@ Anonymous telemetry:\t\"Enabled\"" eprintln!(); if opt.master_key.is_some() { - eprintln!("A Master Key has been set. Requests to MeiliSearch won't be authorized unless you provide an authentication key."); + eprintln!("A Master Key has been set. Requests to Meilisearch won't be authorized unless you provide an authentication key."); } else { eprintln!("No master key found; The server will accept unidentified requests. \ If you need some protection in development mode, please export a key: export MEILI_MASTER_KEY=xxx"); diff --git a/meilisearch-http/src/routes/mod.rs b/meilisearch-http/src/routes/mod.rs index c859dc68f..5ec9cfee4 100644 --- a/meilisearch-http/src/routes/mod.rs +++ b/meilisearch-http/src/routes/mod.rs @@ -117,11 +117,11 @@ impl IndexUpdateResponse { /// Always return a 200 with: /// ```json /// { -/// "status": "MeiliSearch is running" +/// "status": "Meilisearch is running" /// } /// ``` pub async fn running() -> HttpResponse { - HttpResponse::Ok().json(serde_json::json!({ "status": "MeiliSearch is running" })) + HttpResponse::Ok().json(serde_json::json!({ "status": "Meilisearch is running" })) } async fn get_stats( diff --git a/meilisearch-lib/src/index/search.rs b/meilisearch-lib/src/index/search.rs index 3f05e7dc1..99c4e8bf3 100644 --- a/meilisearch-lib/src/index/search.rs +++ b/meilisearch-lib/src/index/search.rs @@ -877,7 +877,7 @@ mod test { assert_eq!(value["publication_year"], "1937"); } - /// https://github.com/meilisearch/MeiliSearch/issues/1368 + /// https://github.com/meilisearch/meilisearch/issues/1368 #[test] fn formatted_with_highlight_emoji() { let stop_words = fst::Set::default(); diff --git a/meilisearch-lib/src/index_controller/versioning/error.rs b/meilisearch-lib/src/index_controller/versioning/error.rs index ef7688bfb..ba284ec91 100644 --- a/meilisearch-lib/src/index_controller/versioning/error.rs +++ b/meilisearch-lib/src/index_controller/versioning/error.rs @@ -1,14 +1,14 @@ #[derive(thiserror::Error, Debug)] pub enum VersionFileError { #[error( - "MeilSearch (v{}) failed to infer the version of the database. Please consider using a dump to load your data.", + "Meilisearch (v{}) failed to infer the version of the database. Please consider using a dump to load your data.", env!("CARGO_PKG_VERSION").to_string() )] MissingVersionFile, - #[error("Version file is corrupted and thus MeiliSearch is unable to determine the version of the database.")] + #[error("Version file is corrupted and thus Meilisearch is unable to determine the version of the database.")] MalformedVersionFile, #[error( - "Expected MeiliSearch engine version: {major}.{minor}.{patch}, current engine version: {}. To update MeiliSearch use a dump.", + "Expected Meilisearch engine version: {major}.{minor}.{patch}, current engine version: {}. To update Meilisearch use a dump.", env!("CARGO_PKG_VERSION").to_string() )] VersionMismatch { diff --git a/meilisearch-lib/src/index_controller/versioning/mod.rs b/meilisearch-lib/src/index_controller/versioning/mod.rs index 4de894ebb..f2c83bdad 100644 --- a/meilisearch-lib/src/index_controller/versioning/mod.rs +++ b/meilisearch-lib/src/index_controller/versioning/mod.rs @@ -12,7 +12,7 @@ static VERSION_MAJOR: &str = env!("CARGO_PKG_VERSION_MAJOR"); static VERSION_MINOR: &str = env!("CARGO_PKG_VERSION_MINOR"); static VERSION_PATCH: &str = env!("CARGO_PKG_VERSION_PATCH"); -// Persists the version of the current MeiliSearch binary to a VERSION file +// Persists the version of the current Meilisearch binary to a VERSION file pub fn create_version_file(db_path: &Path) -> anyhow::Result<()> { let version_path = db_path.join(VERSION_FILE_NAME); fs::write( @@ -23,7 +23,7 @@ pub fn create_version_file(db_path: &Path) -> anyhow::Result<()> { Ok(()) } -// Ensures MeiliSearch version is compatible with the database, returns an error versions mismatch. +// Ensures Meilisearch version is compatible with the database, returns an error versions mismatch. pub fn check_version_file(db_path: &Path) -> anyhow::Result<()> { let version_path = db_path.join(VERSION_FILE_NAME); diff --git a/meilisearch-lib/src/tasks/task.rs b/meilisearch-lib/src/tasks/task.rs index add07f2ad..f5dd8d9be 100644 --- a/meilisearch-lib/src/tasks/task.rs +++ b/meilisearch-lib/src/tasks/task.rs @@ -55,7 +55,7 @@ pub enum TaskEvent { }, } -/// A task represents an operation that MeiliSearch must do. +/// A task represents an operation that Meilisearch must do. /// It's stored on disk and executed from the lowest to highest Task id. /// Everytime a new task is created it has a higher Task id than the previous one. /// See also `Job`. @@ -91,7 +91,7 @@ impl Task { /// A job is like a volatile priority `Task`. /// It should be processed as fast as possible and is not stored on disk. -/// This means, when MeiliSearch is closed all your unprocessed jobs will disappear. +/// This means, when Meilisearch is closed all your unprocessed jobs will disappear. #[derive(Debug, derivative::Derivative)] #[derivative(PartialEq)] pub enum Job { diff --git a/meilisearch-lib/src/tasks/task_store/store.rs b/meilisearch-lib/src/tasks/task_store/store.rs index 52b001dc7..49413f167 100644 --- a/meilisearch-lib/src/tasks/task_store/store.rs +++ b/meilisearch-lib/src/tasks/task_store/store.rs @@ -87,7 +87,7 @@ impl Store { /// This function should be called *right after* creating the store. /// It put back all unfinished update in the `Created` state. This /// allow us to re-enqueue an update that didn't had the time to finish - /// when MeiliSearch closed. + /// when Meilisearch closed. pub fn reset_and_return_unfinished_tasks(&mut self) -> Result>> { let mut unfinished_tasks: BinaryHeap> = BinaryHeap::new();