-
Notifications
You must be signed in to change notification settings - Fork 1.2k
[DOCS] Adds a signpost for downloading ES or signing-up for ESS #2384
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
Conversation
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.
The README file is (unfortunately) ReST, not Markdown, see https://github.com/elastic/elasticsearch-py/blob/bfa8db26287b5c961a01e7445552a716a5696995/README.rst for the current result.
Additionally, should we update the Sphinx and Elasticsearch docs?
@pquentin I addressed your comment via the last commits. |
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.
Thanks! What are your thoughts on moving those to the installation sections?
- README.rst: either remove this or put it just before "Refer to the Installation section"
- guide: either in https://www.elastic.co/guide/en/elasticsearch/client/python-api/current/getting-started-python.html#_installation or in the installation page itself.
- sphinx: I think this one works 👍
@pquentin Keeping a signpost in the repo README about the download locations is kind of the whole point of this PR, so I wouldn't remove it, so I put it in the place you suggested. |
buildkite test this please |
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.
Thanks! LGTM. (If docs CI passes.)
@elasticmachine test this please |
Co-authored-by: Quentin Pradet <quentin.pradet@elastic.co> (cherry picked from commit 336319d)
…up for ESS (#2396) * [DOCS] Adds a signpost for downloading ES or signing-up for ESS (#2384) Co-authored-by: Quentin Pradet <quentin.pradet@elastic.co> (cherry picked from commit 336319d) * Trigger CI --------- Co-authored-by: István Zoltán Szabó <istvan.szabo@elastic.co> Co-authored-by: Quentin Pradet <quentin.pradet@elastic.co>
Overview
This PR adds a signpost to the repo README that links to the ES download page and to the ESS sign-up page.