Skip to content
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

Convert README to markdown for static HTML embedding #2599

Merged
merged 3 commits into from
Jun 26, 2024

Conversation

pquentin
Copy link
Member

Removing the custom processing in setup.py will allow moving to Hatch in the future, to reduce differences with elasticsearch-serverless-python.

You can preview the README here: https://github.com/pquentin/elasticsearch-py/blob/readme.md/README.md but the logo is broken so I've attached a screenshot:

image

Copy link

A documentation preview will be available soon.

Request a new doc build by commenting
  • Rebuild this PR: run docs-build
  • Rebuild this PR and all Elastic docs: run docs-build rebuild

run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.

If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here.

README.md Outdated Show resolved Hide resolved
Copy link
Contributor

@miguelgrinberg miguelgrinberg left a comment

Choose a reason for hiding this comment

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

LGTM, but there is a PHP mention that needs to be fixed.

Co-authored-by: Miguel Grinberg <[email protected]>
@pquentin pquentin merged commit 48b3482 into elastic:main Jun 26, 2024
9 of 11 checks passed
@pquentin pquentin deleted the readme.md branch June 26, 2024 11:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants