maverick/docbrown
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add more information about using Elasticsearch to docs (#6046)

Browse source 
It was unclear to me that I explicitly needed Elasticsearch in order for certain tests to run locally. We should specify that in the docs. Also added a note about installing `wget`, which is required to install Elasticsearch in our docs.
This commit is contained in:
Vaidehi Joshi 2020-02-12 13:23:10 -08:00 • committed by GitHub
parent 2a0a89239c
commit 8a11872472
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 10 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
docs/installation/mac.md
View file

@ -63,8 +63,11 @@ DEV requires Elasticsearch version 7 or higher.
We recommend installing from archive on Mac. The following directions were
[taken from the Elasticsearch docs themselves](https://www.elastic.co/guide/en/elasticsearch/reference/7.5/targz.html#install-macos),
so check those out if you run into any issues or want further information. NOTE:
Make sure to download the OSS version, `elasticsearch-oss`.
so check those out if you run into any issues or want further information. Make
sure to download **the OSS version** of Elasticsearch, `elasticsearch-oss`.
Please note that you will need `wget` in order to proceed with this installation
(`brew install wget`).
```shell
wget https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-oss-7.5.2-darwin-x86_64.tar.gz

5
docs/tests/readme.md
View file

@ -53,3 +53,8 @@ Travis will deploy your pull request to production after CI passes and a member
of the DEV team has approved it.
Our test suite is not perfect and sometimes a re-run is needed.
Please note that you will need to have Elasticsearch installed and running for
certain tests in our test suite. You can find instructions on how to install and
run Elasticsearch specific your environment in the
[Installation Guide](/installation).