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
99: Changes related to the rebranding r=alallema a=meili-bot
_This PR is auto-generated._
- [X] Change the name `MeiliSearch` to `Meilisearch` in README and CONTRIBUTING.
- [x] ⚠️ Ensure the bot did not update part you don’t want it to update, especially in the code examples in the Getting started.
- [x] Please, ensure there is no other "MeiliSearch". For example, in the comments or in the tests name.
- [x] Put the new logo on the README if needed.
Co-authored-by: meili-bot <[email protected]>
Co-authored-by: alallema <[email protected]>
Co-authored-by: Amélie <[email protected]>
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Contributing <!-- omit in toc -->
2
2
3
-
First of all, thank you for contributing to MeiliSearch! The goal of this document is to provide everything you need to know in order to contribute to MeiliSearch and its different integrations.
3
+
First of all, thank you for contributing to Meilisearch! The goal of this document is to provide everything you need to know in order to contribute to Meilisearch and its different integrations.
4
4
5
5
-[Assumptions](#assumptions)
6
6
-[How to Contribute](#how-to-contribute)
@@ -11,8 +11,8 @@ First of all, thank you for contributing to MeiliSearch! The goal of this docume
11
11
## Assumptions
12
12
13
13
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.**
14
-
2.**You've read the MeiliSearch[documentation](https://docs.meilisearch.com) and the [README](/README.md).**
15
-
3.**You know about the [MeiliSearch community](https://docs.meilisearch.com/learn/what_is_meilisearch/contact.html). Please use this for help.**
14
+
2.**You've read the Meilisearch[documentation](https://docs.meilisearch.com) and the [README](/README.md).**
15
+
3.**You know about the [Meilisearch community](https://docs.meilisearch.com/learn/what_is_meilisearch/contact.html). Please use this for help.**
16
16
17
17
## How to Contribute
18
18
@@ -46,7 +46,7 @@ You can install and test the Helm chart by running:
<palign="center">The MeiliSearch tool for Kubernetes ⚓️</p>
21
+
<palign="center">The Meilisearch tool for Kubernetes ⚓️</p>
22
22
23
-
**MeiliSearch** is an open-source search engine. [Discover what MeiliSearch is!](https://github.com/meilisearch/MeiliSearch)
23
+
**Meilisearch** is an open-source search engine. [Discover what Meilisearch is!](https://github.com/meilisearch/meilisearch)
24
24
25
25
## Table of Contents <!-- omit in toc -->
26
26
27
27
-[📖 Documentation](#-documentation)
28
28
-[🚀 Getting Started](#-getting-started)
29
-
-[🤖 Compatibility with MeiliSearch](#-compatibility-with-meilisearch)
29
+
-[🤖 Compatibility with Meilisearch](#-compatibility-with-meilisearch)
30
30
-[⚙️ Development Workflow and Contributing](#️-development-workflow-and-contributing)
31
31
32
32
## 📖 Documentation
@@ -36,41 +36,41 @@ See our [Documentation](https://docs.meilisearch.com/learn/tutorials/getting_sta
36
36
## 🚀 Getting Started
37
37
38
38
39
-
Kubernetes (K8s), is an open-source system for automating deployment, scaling, and management of containerized applications. You can run a MeiliSearch instance inside your Kubernetes cluster, either if you want to expose it to the outside world or just let some other applications use it inside your cluster and take advantage of the instant and powerful search engine.
39
+
Kubernetes (K8s), is an open-source system for automating deployment, scaling, and management of containerized applications. You can run a Meilisearch instance inside your Kubernetes cluster, either if you want to expose it to the outside world or just let some other applications use it inside your cluster and take advantage of the instant and powerful search engine.
40
40
41
41
First of all, you will need a Kubernetes cluster up and running. If you are not familiar with how Kuberentes works or need some help with this step, please check the [Kubernetes documentation](https://kubernetes.io/docs/home/).
42
42
43
43
### Install kubectl <!-- omit in toc -->
44
44
45
45
`kubectl` is the most commonly used CLI to manage a Kubernetes cluster. The installation instructions are [available here](https://kubernetes.io/docs/tasks/tools/install-kubectl/).
46
46
47
-
### Deploy MeiliSearch using manifests <!-- omit in toc -->
47
+
### Deploy Meilisearch using manifests <!-- omit in toc -->
48
48
49
-
#### Install and run MeiliSearch<!-- omit in toc -->
49
+
#### Install and run Meilisearch<!-- omit in toc -->
50
50
51
51
```bash
52
52
kubectl apply -f manifests/meilisearch.yaml
53
53
```
54
54
55
-
#### Uninstall MeiliSearch<!-- omit in toc -->
55
+
#### Uninstall Meilisearch<!-- omit in toc -->
56
56
57
57
```bash
58
58
kubectl delete -f manifests/meilisearch.yaml
59
59
```
60
60
61
-
### Deploy MeiliSearch using Helm <!-- omit in toc -->
61
+
### Deploy Meilisearch using Helm <!-- omit in toc -->
62
62
63
-
Helm works as a package manager to run pre-configured Kubernetes resources. Using our [Helm chart](https://github.com/meilisearch/meilisearch-kubernetes/tree/main/charts/meilisearch) you will be able to deploy a MeiliSearch instance in you Kubernetes cluster, with several customizable configurations.
63
+
Helm works as a package manager to run pre-configured Kubernetes resources. Using our [Helm chart](https://github.com/meilisearch/meilisearch-kubernetes/tree/main/charts/meilisearch) you will be able to deploy a Meilisearch instance in you Kubernetes cluster, with several customizable configurations.
64
64
65
65
#### Install helm <!-- omit in toc -->
66
66
67
67
Helm CLI is a Command Line Interface which will automate chart management and installation on your Kubernetes cluster. To install Helm, follow the [Helm installation instructions](https://helm.sh/docs/intro/install/).
68
68
69
69
The [Parameters](https://github.com/meilisearch/meilisearch-kubernetes/tree/main/charts/meilisearch#parameters) section lists the parameters that can be configured during installation.
70
70
71
-
#### Install MeiliSearch chart <!-- omit in toc -->
71
+
#### Install Meilisearch chart <!-- omit in toc -->
# Replace <your-instance-name> with the name of your deployed service
90
90
helm uninstall <your-service-name>
91
91
```
92
92
93
-
## 🤖 Compatibility with MeiliSearch
93
+
## 🤖 Compatibility with Meilisearch
94
94
95
-
This chart only guarantees the compatibility with the [version v0.25.0 of MeiliSearch](https://github.com/meilisearch/MeiliSearch/releases/tag/v0.25.0).
95
+
This chart only guarantees the compatibility with the [version v0.25.0 of Meilisearch](https://github.com/meilisearch/meilisearch/releases/tag/v0.25.0).
96
96
97
97
## ⚙️ Development Workflow and Contributing
98
98
@@ -102,4 +102,4 @@ If you want to know more about the development workflow or want to contribute, p
102
102
103
103
<hr>
104
104
105
-
**MeiliSearch** provides and maintains many **SDKs and Integration tools** like this one. We want to provide everyone with an **amazing search experience for any kind of project**. If you want to contribute, make suggestions, or just know what's going on right now, visit us in the [integration-guides](https://github.com/meilisearch/integration-guides) repository.
105
+
**Meilisearch** provides and maintains many **SDKs and Integration tools** like this one. We want to provide everyone with an **amazing search experience for any kind of project**. If you want to contribute, make suggestions, or just know what's going on right now, visit us in the [integration-guides](https://github.com/meilisearch/integration-guides) repository.
Copy file name to clipboardExpand all lines: charts/meilisearch/README.md
+9-9Lines changed: 9 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
3
Helm works as a package manager to run pre-configured Kubernetes resources.
4
4
5
-
MeiliSearch provides a customizable Helm chart, ready to deploy a [Meilisearch](https://github.com/meilisearch/MeiliSearch) instance on your Kubernetes cluster.
5
+
Meilisearch provides a customizable Helm chart, ready to deploy a [Meilisearch](https://github.com/meilisearch/meilisearch) instance on your Kubernetes cluster.
6
6
7
7
# Getting started
8
8
@@ -16,7 +16,7 @@ First of all, you will need a Kubernetes cluster up and running. If you are not
16
16
17
17
Helm CLI is a Command Line Interface which will automate chart management and installation on your Kubernetes cluster. To install Helm, follow the [Helm installation instructions](https://helm.sh/docs/intro/install/)
This command deploys MeiliSearch on your Kubernetes cluster using the default configuration. The [Parameters](#parameters) section lists the parameters that can be configured during installation.
30
+
This command deploys Meilisearch on your Kubernetes cluster using the default configuration. The [Parameters](#parameters) section lists the parameters that can be configured during installation.
31
31
32
32
## Uninstalling the Chart
33
33
34
-
To uninstall/delete the `MeiliSearch` deployment:
34
+
To uninstall/delete the `Meilisearch` deployment:
35
35
36
36
```bash
37
37
# Replace <your-instance-name> with the name of your deployed service
The `environment` block allows to specify all the environment variables declared on [MeiliSearch Configuration](https://docs.meilisearch.com/guides/advanced_guides/configuration.html#passing-arguments-via-the-command-line)
105
+
The `environment` block allows to specify all the environment variables declared on [Meilisearch Configuration](https://docs.meilisearch.com/guides/advanced_guides/configuration.html#passing-arguments-via-the-command-line)
106
106
107
107
For production deployment, the `environment.MEILI_MASTER_KEY` is required. If `MEILI_ENV` is set to "production" without setting `environment.MEILI_MASTER_KEY`, then this chart will automatically create a secure `environment.MEILI_MASTER_KEY` as a secret. To get the value of this secret, you can read it with this command: `kubectl get secret meilisearch-master-key --template={{.data.MEILI_MASTER_KEY}} | base64 --decode`. You can also use `auth.existingMasterKeySecret` to use an existing secret that has the key `MEILI_MASTER_KEY`
0 commit comments