Skip to content

Commit 3391368

Browse files
bors[bot]meili-botalallema
authored
Merge #99
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]>
2 parents d301e12 + 2078e17 commit 3391368

File tree

6 files changed

+35
-36
lines changed

6 files changed

+35
-36
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,5 +22,5 @@ If applicable, add screenshots or logs to help explain your problem.
2222

2323
**Environment (please complete the following information):**
2424
- OS: [e.g. Debian GNU/Linux]
25-
- MeiliSearch version: [e.g. v.0.20.0]
25+
- Meilisearch version: [e.g. v.0.20.0]
2626
- meilisearch-kubernetes version: [e.g v0.1.14]

CONTRIBUTING.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Contributing <!-- omit in toc -->
22

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.
44

55
- [Assumptions](#assumptions)
66
- [How to Contribute](#how-to-contribute)
@@ -11,8 +11,8 @@ First of all, thank you for contributing to MeiliSearch! The goal of this docume
1111
## Assumptions
1212

1313
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.**
1616

1717
## How to Contribute
1818

@@ -46,7 +46,7 @@ You can install and test the Helm chart by running:
4646
helm install meilisearch-chart-test -f charts/meilisearch/values.yaml charts/meilisearch
4747
```
4848

49-
An easy way to access your MeiliSearch instance and test that it is up and running is by using port-forwarding. This can be achieved by running:
49+
An easy way to access your Meilisearch instance and test that it is up and running is by using port-forwarding. This can be achieved by running:
5050

5151
```bash
5252
kubectl port-forward --namespace default svc/meilisearch 7700:7700
@@ -119,7 +119,7 @@ Some notes on GitHub PRs:
119119

120120
## Release Process (for internal team only)
121121

122-
MeiliSearch tools follow the [Semantic Versioning Convention](https://semver.org/).
122+
Meilisearch tools follow the [Semantic Versioning Convention](https://semver.org/).
123123

124124
### Automation to Rebase and Merge the PRs <!-- omit in toc -->
125125

LICENSE

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2020 sa
4-
Copyright (c) 2020-2021 MeiliSearch
3+
Copyright (c) 2020-2021 Meilisearch
54

65
Permission is hereby granted, free of charge, to any person obtaining a copy
76
of this software and associated documentation files (the "Software"), to deal

README.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
<p align="center">
2-
<img src="https://raw.githubusercontent.com/meilisearch/integration-guides/main/assets/logos/meilisearch_k8s.svg" alt="Instant-MeiliSearch" width="200" height="200" />
2+
<img src="https://raw.githubusercontent.com/meilisearch/integration-guides/main/assets/logos/meilisearch_k8s.svg" alt="Meilisearch Kubernetes" width="200" height="200" />
33
</p>
44

5-
<h1 align="center">MeiliSearch Kubernetes</h1>
5+
<h1 align="center">Meilisearch Kubernetes</h1>
66

77
<h4 align="center">
8-
<a href="https://github.com/meilisearch/MeiliSearch">MeiliSearch</a> |
8+
<a href="https://github.com/meilisearch/meilisearch">Meilisearch</a> |
99
<a href="https://docs.meilisearch.com">Documentation</a> |
1010
<a href="https://slack.meilisearch.com">Slack</a> |
1111
<a href="https://www.meilisearch.com">Website</a> |
@@ -18,15 +18,15 @@
1818
<a href="https://app.bors.tech/repositories/29795"><img src="https://bors.tech/images/badge_small.svg" alt="Bors enabled"></a>
1919
</p>
2020

21-
<p align="center">The MeiliSearch tool for Kubernetes ⚓️</p>
21+
<p align="center">The Meilisearch tool for Kubernetes ⚓️</p>
2222

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)
2424

2525
## Table of Contents <!-- omit in toc -->
2626

2727
- [📖 Documentation](#-documentation)
2828
- [🚀 Getting Started](#-getting-started)
29-
- [🤖 Compatibility with MeiliSearch](#-compatibility-with-meilisearch)
29+
- [🤖 Compatibility with Meilisearch](#-compatibility-with-meilisearch)
3030
- [⚙️ Development Workflow and Contributing](#️-development-workflow-and-contributing)
3131

3232
## 📖 Documentation
@@ -36,41 +36,41 @@ See our [Documentation](https://docs.meilisearch.com/learn/tutorials/getting_sta
3636
## 🚀 Getting Started
3737

3838

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.
4040

4141
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/).
4242

4343
### Install kubectl <!-- omit in toc -->
4444

4545
`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/).
4646

47-
### Deploy MeiliSearch using manifests <!-- omit in toc -->
47+
### Deploy Meilisearch using manifests <!-- omit in toc -->
4848

49-
#### Install and run MeiliSearch <!-- omit in toc -->
49+
#### Install and run Meilisearch <!-- omit in toc -->
5050

5151
```bash
5252
kubectl apply -f manifests/meilisearch.yaml
5353
```
5454

55-
#### Uninstall MeiliSearch <!-- omit in toc -->
55+
#### Uninstall Meilisearch <!-- omit in toc -->
5656

5757
```bash
5858
kubectl delete -f manifests/meilisearch.yaml
5959
```
6060

61-
### Deploy MeiliSearch using Helm <!-- omit in toc -->
61+
### Deploy Meilisearch using Helm <!-- omit in toc -->
6262

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.
6464

6565
#### Install helm <!-- omit in toc -->
6666

6767
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/).
6868

6969
The [Parameters](https://github.com/meilisearch/meilisearch-kubernetes/tree/main/charts/meilisearch#parameters) section lists the parameters that can be configured during installation.
7070

71-
#### Install MeiliSearch chart <!-- omit in toc -->
71+
#### Install Meilisearch chart <!-- omit in toc -->
7272

73-
First, add the meilisearch chart repository
73+
First, add the Meilisearch chart repository
7474
```bash
7575
helm repo add meilisearch https://meilisearch.github.io/meilisearch-kubernetes
7676
```
@@ -83,16 +83,16 @@ helm upgrade -i <your-service-name> meilisearch/meilisearch
8383

8484
#### Uninstalling the Chart <!-- omit in toc -->
8585

86-
To uninstall/delete the MeiliSearch` deployment:
86+
To uninstall/delete the Meilisearch deployment:
8787

8888
```bash
8989
# Replace <your-instance-name> with the name of your deployed service
9090
helm uninstall <your-service-name>
9191
```
9292

93-
## 🤖 Compatibility with MeiliSearch
93+
## 🤖 Compatibility with Meilisearch
9494

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

9797
## ⚙️ Development Workflow and Contributing
9898

@@ -102,4 +102,4 @@ If you want to know more about the development workflow or want to contribute, p
102102

103103
<hr>
104104

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.

charts/meilisearch/Chart.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ apiVersion: v1
22
appVersion: "v0.25.2"
33
description: A Helm chart for the Meilisearch search engine
44
name: meilisearch
5-
version: 0.1.25
5+
version: 0.1.26
66
icon: https://res.cloudinary.com/meilisearch/image/upload/v1597822872/Logo/logo_img.svg
77
home: https://github.com/meilisearch/meilisearch-kubernetes/charts
88
maintainers:

charts/meilisearch/README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Helm works as a package manager to run pre-configured Kubernetes resources.
44

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.
66

77
# Getting started
88

@@ -16,7 +16,7 @@ First of all, you will need a Kubernetes cluster up and running. If you are not
1616

1717
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/)
1818

19-
### Install MeiliSearch chart
19+
### Install Meilisearch chart
2020

2121
Clone this repository and install the chart
2222

@@ -27,11 +27,11 @@ cd meilisearch-kubernetes
2727
helm install <your-service-name> charts/meilisearch
2828
```
2929

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.
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.
3131

3232
## Uninstalling the Chart
3333

34-
To uninstall/delete the `MeiliSearch` deployment:
34+
To uninstall/delete the `Meilisearch` deployment:
3535

3636
```bash
3737
# Replace <your-instance-name> with the name of your deployed service
@@ -46,19 +46,19 @@ helm uninstall <your-service-name>
4646
| | |
4747
| `fullnameOverride` | String to fully override meilisearch.fullname | `nil`
4848
| | |
49-
| `replicaCount` | Number of MeiliSearch pods to run | `1`
49+
| `replicaCount` | Number of Meilisearch pods to run | `1`
5050
| | |
5151
| `environment.MEILI_ENV` | Sets the environment. Either **production** or **development** | `development`
5252
| | |
5353
| `environment.MEILI_NO_ANALYTICS` | Deactivates analytics | `true`
5454
| | |
5555
| `auth.existingMasterKeySecret` | Uses an existing secret that has the MEILI_MASTER_KEY set | `nil`
5656
| | |
57-
| `image.repository` | MeiliSearch image name | `getmeili/meilisearch`
57+
| `image.repository` | Meilisearch image name | `getmeili/meilisearch`
5858
| | |
59-
| `image.tag` | MeiliSearch image tag | `{TAG_NAME}`
59+
| `image.tag` | Meilisearch image tag | `{TAG_NAME}`
6060
| | |
61-
| `image.pullPolicy` | MeiliSearch image pull policy | `IfNotPresent`
61+
| `image.pullPolicy` | Meilisearch image pull policy | `IfNotPresent`
6262
| | |
6363
| `image.pullSecret` | Secret to authenticate against the docker registry | '' |
6464
| | |
@@ -102,6 +102,6 @@ helm uninstall <your-service-name>
102102

103103
### Environment
104104

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)
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)
106106

107107
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

Comments
 (0)