Skip to content

Commit cf73f2c

Browse files
bors[bot]meili-bot
andauthored
Merge #155
155: Remove dollars from bash command examples r=curquiza a=meili-bot _This PR is auto-generated._ Related to meilisearch/integration-guides#99 and meilisearch/integration-guides#103. Co-authored-by: meili-bot <[email protected]>
2 parents f0b32cf + 2ea61f9 commit cf73f2c

File tree

2 files changed

+12
-12
lines changed

2 files changed

+12
-12
lines changed

CONTRIBUTING.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ First of all, thank you for contributing to MeiliSearch! The goal of this docume
3333
### Setup
3434

3535
```bash
36-
$ bundle install
36+
bundle install
3737
```
3838

3939
### Tests
@@ -42,21 +42,21 @@ Each PR should pass the tests to be accepted.
4242

4343
```bash
4444
# Tests
45-
$ docker pull getmeili/meilisearch:latest # Fetch the latest version of MeiliSearch image from Docker Hub
46-
$ docker run -p 7700:7700 getmeili/meilisearch:latest ./meilisearch --master-key=masterKey --no-analytics=true
47-
$ bundle exec rspec
45+
docker pull getmeili/meilisearch:latest # Fetch the latest version of MeiliSearch image from Docker Hub
46+
docker run -p 7700:7700 getmeili/meilisearch:latest ./meilisearch --master-key=masterKey --no-analytics=true
47+
bundle exec rspec
4848
```
4949

5050
To launch a specific folder or file:
5151

5252
```bash
53-
$ bundle exec rspec spec/meilisearch/index/base_spec.rb
53+
bundle exec rspec spec/meilisearch/index/base_spec.rb
5454
```
5555

5656
To launch a single test in a specific file:
5757

5858
```bash
59-
$ bundle exec rspec spec/meilisearch/index/search_spec.rb -e 'does a basic search in index'
59+
bundle exec rspec spec/meilisearch/index/search_spec.rb -e 'does a basic search in index'
6060
```
6161

6262
### Linter
@@ -65,17 +65,17 @@ Each PR should pass the linter to be accepted.
6565

6666
```bash
6767
# Check the linter errors
68-
$ bundle exec rubocop lib/ spec/
68+
bundle exec rubocop lib/ spec/
6969
# Auto-correct the linter errors
70-
$ bundle exec rubocop -a lib/ spec/
70+
bundle exec rubocop -a lib/ spec/
7171
```
7272

7373
If you think the remaining linter errors are acceptable, do not add any `rubocop` in-line comments in the code.<br>
7474
This project uses a `rubocop_todo.yml` file that is generated. Do not modify this file manually.<br>
7575
To update it, run the following command:
7676

7777
```bash
78-
$ bundle exec rubocop --auto-gen-config
78+
bundle exec rubocop --auto-gen-config
7979
```
8080

8181
### Want to debug?

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ This package requires Ruby version 2.6.0 or later.
4545

4646
With `gem` in command line:
4747
```bash
48-
$ gem install meilisearch
48+
gem install meilisearch
4949
```
5050

5151
In your `Gemfile` with [bundler](https://bundler.io/):
@@ -62,8 +62,8 @@ There are many easy ways to [download and run a MeiliSearch instance](https://do
6262
For example, if you use Docker:
6363

6464
```bash
65-
$ docker pull getmeili/meilisearch:latest # Fetch the latest version of MeiliSearch image from Docker Hub
66-
$ docker run -it --rm -p 7700:7700 getmeili/meilisearch:latest ./meilisearch --master-key=masterKey
65+
docker pull getmeili/meilisearch:latest # Fetch the latest version of MeiliSearch image from Docker Hub
66+
docker run -it --rm -p 7700:7700 getmeili/meilisearch:latest ./meilisearch --master-key=masterKey
6767
```
6868

6969
NB: you can also download MeiliSearch from **Homebrew** or **APT**.

0 commit comments

Comments
 (0)