Skip to content

Remove dollars from bash command examples #104

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 11, 2021
Merged

Remove dollars from bash command examples #104

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d1ea429
Update CONTRIBUTING.md
meili-bot Mar 11, 2021
0699b96
Update README.md
meili-bot Mar 11, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,18 +35,18 @@ Set both environment variables `MEILISEARCH_HOST_URL` and `MEILISEARCH_API_KEY`.
Then, run:

```bash
$ pipenv install
$ pipenv run ./docs_scraper <path-to-your-config-file>
pipenv install
pipenv run ./docs_scraper <path-to-your-config-file>
```

### Linter and Tests <!-- omit in TOC -->

```bash
$ pipenv install --dev
pipenv install --dev
# Linter
$ pipenv run pylint scraper
pipenv run pylint scraper
# Tests
$ pipenv run pytest ./scraper/src -k "not _browser"
pipenv run pytest ./scraper/src -k "not _browser"
```

## Git Guidelines
Expand Down
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,8 +70,8 @@ Your documentation content needs to be scraped and pushed into a MeiliSearch ins
You can install and run MeiliSearch on your machine using `curl`.

```bash
$ curl -L https://install.meilisearch.com | sh
$ ./meilisearch --master-key=myMasterKey
curl -L https://install.meilisearch.com | sh
./meilisearch --master-key=myMasterKey
```

There are [other ways to install MeiliSearch](https://docs.meilisearch.com/learn/tutorials/getting_started.html#download-and-launch).
Expand Down Expand Up @@ -142,16 +142,16 @@ Following on from the example in the [first step](#run-your-meilisearch-instance

Then, run:
```bash
$ pipenv install
$ pipenv run ./docs_scraper <path-to-your-config-file>
pipenv install
pipenv run ./docs_scraper <path-to-your-config-file>
```

`<path-to-your-config-file>` should be the path of your configuration file defined at the [previous step](#set-your-config-file).

#### With Docker <!-- omit in TOC -->

```bash
$ docker run -t --rm \
docker run -t --rm \
-e MEILISEARCH_HOST_URL=<your-meilisearch-host-url> \
-e MEILISEARCH_API_KEY=<your-meilisearch-api-key> \
-v <absolute-path-to-your-config-file>:/docs-scraper/config.json \
Expand Down