Skip to content

[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

Merged
merged 7 commits into from
Dec 4, 2023

Conversation

szabosteve
Copy link
Contributor

Overview

This PR adds a signpost to the repo README that links to the ES download page and to the ESS sign-up page.

@szabosteve szabosteve requested a review from pquentin November 24, 2023 16:26
@szabosteve szabosteve marked this pull request as ready for review November 24, 2023 16:26
Copy link
Member

@pquentin pquentin left a 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?

@szabosteve szabosteve requested a review from pquentin November 27, 2023 08:27
@szabosteve
Copy link
Contributor Author

@pquentin I addressed your comment via the last commits.

Copy link
Member

@pquentin pquentin left a 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?

@szabosteve
Copy link
Contributor Author

szabosteve commented Dec 4, 2023

@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.

@pquentin
Copy link
Member

pquentin commented Dec 4, 2023

buildkite test this please

Copy link
Member

@pquentin pquentin left a 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.)

@szabosteve
Copy link
Contributor Author

@elasticmachine test this please

@szabosteve szabosteve merged commit 336319d into main Dec 4, 2023
@szabosteve szabosteve deleted the szabosteve/signpost-readme branch December 4, 2023 16:51
github-actions bot pushed a commit that referenced this pull request Dec 4, 2023
Co-authored-by: Quentin Pradet <quentin.pradet@elastic.co>
(cherry picked from commit 336319d)
pquentin added a commit that referenced this pull request Dec 8, 2023
…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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants