Skip to content

Homebrew instructions#26847

Merged
jasontedor merged 4 commits intoelastic:5.6from
vurple:patch-1
Oct 10, 2017
Merged

Homebrew instructions#26847
jasontedor merged 4 commits intoelastic:5.6from
vurple:patch-1

Conversation

@vurple
Copy link
Copy Markdown
Contributor

@vurple vurple commented Sep 30, 2017

Updated getting-started.asciidoc to include instructions for installing elasticsearch with Homebrew.

  • Have you signed the contributor license agreement?
  • Have you followed the contributor guidelines?
  • If submitting code, have you built your formula locally prior to submission with gradle check?
  • If submitting code, is your pull request against master? Unless there is a good reason otherwise, we prefer pull requests against master and will backport as needed.
  • If submitting code, have you checked that your submission is for an OS that we support?
  • If you are submitting this code for a class then read our policy for that.

@vurple
Homebrew instructions
cbec80e 
Updated getting-started.asciidoc to include instructions for installing elasticsearch with Homebrew.
@elasticmachine
Copy link
Copy Markdown
Collaborator

elasticmachine commented Sep 30, 2017

Since this is a community submitted pull request, a Jenkins build has not been kicked off automatically. Can an Elastic organization member please verify the contents of this patch and then kick off a build manually?

@cbuescher cbuescher added the >docs General docs changes label Oct 2, 2017
@cbuescher
Copy link
Copy Markdown
Member

cbuescher commented Oct 2, 2017

Hi @vurple,
thanks for opening this pull request. I'm not sure we want to add installation via Homebrew to the official docs since it is not one of out officially supported ways of installation.
I'll leave this open for a bit to leave room for others to comment though.

@jasontedor
Copy link
Copy Markdown
Member

jasontedor commented Oct 2, 2017

It's not officially supported as macOS is not officially supported, but it's important for our community that usage on macOS be simple and reliable which is why we work to ensure that Elasticsearch works on macOS on top of the OS that we do officially support (i.e., it's unofficially supported). So: we worked to ensure that installation could proceed when Elasticsearch 5.0.0 was released, and we keep the formula up to date on each new release of Elasticsearch. I think that including something here is okay, but I don't think it needs to be full instructions. We can simply say something like "Elasticsearch can be installed on macOS via Homebrew".

@jasontedor
Copy link
Copy Markdown
Member

jasontedor commented Oct 5, 2017

@vurple Can you update per my suggestion?

jasontedor
jasontedor requested changes Oct 5, 2017
View reviewed changes
Copy link
Copy Markdown
Member

@jasontedor jasontedor left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I left a formal review.

docs/reference/getting-started.asciidoc Outdated
=== Installation example with Homebrew

--------------------------------------------------
brew install elasticsearch
Copy link
Copy Markdown
Member

@jasontedor jasontedor Oct 5, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don’t think we need full details on how to use Homebrew here, a comment saying that Elasticsearch can be installed via Honebrew is sufficient.

jasontedor
jasontedor approved these changes Oct 10, 2017
View reviewed changes
Copy link
Copy Markdown
Member

@jasontedor jasontedor left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I pushed a few changes (fixed the heading, added some formatting, added a link to Homebrew, etc.) but this otherwise LGTM.

@jasontedor jasontedor changed the base branch from 5.6 to master October 10, 2017 10:19
@jasontedor jasontedor changed the base branch from master to 5.6 October 10, 2017 10:19
@jasontedor jasontedor merged commit 08a0d4d into elastic:5.6 Oct 10, 2017
jasontedor pushed a commit that referenced this pull request Oct 10, 2017
@vurple @jasontedor
Add Homebrew instructions to getting started
b3e9aa8 
This commit adds instructions for installing Elasticsearch via Homebrew
to the Getting Started guide.

Relates #26847
jasontedor pushed a commit that referenced this pull request Oct 10, 2017
@vurple @jasontedor
Add Homebrew instructions to getting started
181c970 
This commit adds instructions for installing Elasticsearch via Homebrew
to the Getting Started guide.

Relates #26847
jasontedor pushed a commit that referenced this pull request Oct 10, 2017
@vurple @jasontedor
Add Homebrew instructions to getting started
3be68d7 
This commit adds instructions for installing Elasticsearch via Homebrew
to the Getting Started guide.

Relates #26847
@jasontedor
Copy link
Copy Markdown
Member

jasontedor commented Oct 10, 2017

Thanks @vurple.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jasontedor jasontedor jasontedor approved these changes

Assignees

No one assigned

Labels

>docs General docs changes

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@vurple @elasticmachine @cbuescher @jasontedor