-
Notifications
You must be signed in to change notification settings - Fork 24.9k
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.
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
Add missing info about Homebrew installation #28902
Conversation
A better fix is probably to make the above change and also to put the “Successfully running node” section into a different file and refer users to it as the next file at the end of each installation section. It is currently difficult to ascertain that that section pertains to all of the installation platforms and methods, not only to the MSI Windows one.
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? |
1 similar comment
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? |
cc @elastic/es-core-infra |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@jrpool Hi, thanks for the suggestion and sorry for getting to this only just now. I left a comment with a suggestion of how to enhance the change a bit, but we don't have to. Let me know if you agree and want to make the suggested change, I can merge it in then.
@@ -158,6 +158,8 @@ On macOS, Elasticsearch can also be installed via https://brew.sh[Homebrew]: | |||
brew install elasticsearch | |||
-------------------------------------------------- | |||
|
|||
If installation succeeds, Homebrew will finish by saying that you can start Elasticsearch by entering `elasticsearch`. Do that now. The expected response is described below, under `Successfully running node`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe you could add an anchor like [[successfully-running-node]]
to the section in question and then reference it with an internal cross references <<....>>
? I think that would make navigating to the next step even easier.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you, @cbuescher. I lost track of your suggestion. Now I have implemented it, after a long delay.
@jrpool Hi, just checking in with you to see if you are still interested in adding this PR to the documentation. I think its a good change and the comment I left is purely optional, but I would like to get your feedback and maybe see if we can improve with the small suggested change before merging this. |
Hi @jrpool, great you want to add the internal link as an improvement. Unfortunately the link still isn't working for me. I think you need to add an anchor tag as a target to the section you link to. I will mark the place I think it needs to go as a comment. If you are interested I can also point you to the steps you can take to test building the markdown of a documentation page locally, however if you are not planning to do this a lot its probably a bit too much work. I can also add the change on top of your PR if you like, but maybe you prefer to do that yourself. Just let me know. |
@@ -158,6 +158,8 @@ On macOS, Elasticsearch can also be installed via https://brew.sh[Homebrew]: | |||
brew install elasticsearch | |||
-------------------------------------------------- | |||
|
|||
If installation succeeds, Homebrew will finish by saying that you can start Elasticsearch by entering `elasticsearch`. Do that now. The expected response is described below, under <<successfully-running-node>>. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It appears I cannot easily make comments in sections that were not changed, so I'm adding it here. I think you need an anchor [[successfully-running-node]]
later above the section title you are linking to. I added it locally at line 221 (between the [float] marker and the section title). Another small thing if you are editing this file another time anyway: we try to keep the line length a bit shorter (although this is not consistently applied throughout the docs, as demonstrated just a few lines below), so if you don't mind I think this could use a line break maybe after the first sentence. Not a necessary change though.
Several others exist in this file that could be split for consistency.
I have split the long line, @cbuescher, but I suggest we discuss the fact that the link works in my environment and not in yours. The HTML source for the link, as I see in in the Github interface, is:
The destination heading is:
I understand that Github Flavored Markdown imports CSS and/or JS that creates an unprefixed link hidden except on hover, and in my environment the link goes there. What user agent are you using? |
I suspect you are referring to https://github.com/jrpool/elasticsearch/blob/6194bb18c920c47ff05258d29becfe4f2b50a06f/docs/reference/getting-started.asciidoc? When I mean the link doesn't work I refer to building our documentation that is pushed to the webpage as described in https://github.com/cbuescher/docs/blob/master/README.asciidoc.
Let me know whatever works for you. |
Thanks for explaining this issue. I don’t expect to be working with ElasticSearch much in the near future, so I have opted for one of the easier alternatives. If it isn’t entirely correct, please feel free to add an additional fix. |
Great, thanks for pushing the commit. I will kick off some final tests before merging. |
@elasticmachine test this please |
Adding a note about proceeding after a successful homebrew installation.
Adding a note about proceeding after a successful homebrew installation.
Adding a note about proceeding after a successful homebrew installation.
@jrpool thanks again for your time. I merged the change to the 6.2 documentation and newer versions. |
* 6.x: [DOCS] Omit shard failures assertion for incompatible responses (#31430) [DOCS] Move licensing APIs to docs (#31445) backport of: add is-write-index flag to aliases (#30942) (#31412) backport of: Add rollover-creation-date setting to rolled over index (#31144) (#31413) [Docs] Extend Homebrew installation instructions (#28902) [Docs] Mention ip_range datatypes on ip type page (#31416) Multiplexing token filter (#31208) Fix use of time zone in date_histogram rewrite (#31407) Revert "Mute DefaultShardsIT#testDefaultShards test" [DOCS] Fixes code snippet testing for machine learning (#31189) Security: fix joining cluster with production license (#31341) [DOCS] Updated version in Info API example [DOCS] Moves the info API to docs (#31121) Revert "Increasing skip version for failing test on 6.x" Preserve response headers on cluster update task (#31421) [DOCS] Add code snippet testing for more ML APIs (#31404) Docs: Advice for reindexing many indices (#31279)
* master: [DOCS] Omit shard failures assertion for incompatible responses (#31430) [DOCS] Move licensing APIs to docs (#31445) Add Delete Snapshot High Level REST API Remove QueryCachingPolicy#ALWAYS_CACHE (#31451) [Docs] Extend Homebrew installation instructions (#28902) Choose JVM options ergonomically [Docs] Mention ip_range datatypes on ip type page (#31416) Multiplexing token filter (#31208) Fix use of time zone in date_histogram rewrite (#31407) Core: Remove index name resolver from base TransportAction (#31002) [DOCS] Fixes code snippet testing for machine learning (#31189) [DOCS] Removed and params from MLT. Closes #28128 (#31370) Security: fix joining cluster with production license (#31341) Unify http channels and exception handling (#31379) [DOCS] Moves the info API to docs (#31121) Preserve response headers on cluster update task (#31421) [DOCS] Add code snippet testing for more ML APIs (#31404) Do not preallocate bytes for channel buffer (#31400) Docs: Advice for reindexing many indices (#31279) Mute HttpExporterTests#testHttpExporterShutdown test Tracked by #31433 Docs: Add note about removing prepareExecute from the java client (#31401) Make release notes ignore the `>test-failure` label. (#31309)
A better fix is probably to make the above change and also to put the “Successfully running node” section into a different file and refer users to it as the next file at the end of each installation section. It is currently difficult to ascertain that that section pertains to all of the installation platforms and methods, not only to the MSI Windows one.
gradle check
?