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

Reorganization of the Sphinx docs to only include reference pages #2776

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

miguelgrinberg
Copy link
Contributor

@miguelgrinberg miguelgrinberg commented Jan 29, 2025

Reorganization of the Sphinx docs to only include reference pages.

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.

@miguelgrinberg miguelgrinberg marked this pull request as ready for review January 30, 2025 20:27
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.

LGTM, but we should wait for HTTP redirects to be in place before merging IMO.

Including a redirect from /api.html to /index.html.

@miguelgrinberg
Copy link
Contributor Author

miguelgrinberg commented Jan 31, 2025

@pquentin Redirect table proposal:

source target
/en/latest/ No change
/en/latest/quickstart.html https://www.elastic.co/guide/en/elasticsearch/client/python-api/master/getting-started-python.html
/en/latest/interactive.html https://www.elastic.co/guide/en/elasticsearch/client/python-api/master/examples.html
/en/latest/api.html /en/latest/index.html
/en/latest/exceptions.html No change
/en/latest/async.html https://www.elastic.co/guide/en/elasticsearch/client/python-api/master/async.html
/en/latest/helpers.html https://www.elastic.co/guide/en/elasticsearch/client/python-api/master/client-helpers.html

The api.html, async.html and helpers.html exist in both old and new designs. Would it make sense rename these pages in the redesigned docs, so that we can add the redirects above and also have pages we can link from now on?

And aside from this, it is unfortunate but I think we are going to have to create redirects for each version that we publish, until we decide this isn't necessary anymore, because we want the <= 8.17 docs to be redirect free, meaning that we cannot do generic redirects across all versions.

@pquentin
Copy link
Member

The api.html, async.html and helpers.html exist in both old and new designs. Would it make sense rename these pages in the redesigned docs, so that we can add the redirects above and also have pages we can link from now on?

Yes, good point.

And aside from this, it is unfortunate but I think we are going to have to create redirects for each version that we publish, until we decide this isn't necessary anymore, because we want the <= 8.17 docs to be redirect free, meaning that we cannot do generic redirects across all versions.

That makes sense. The free plan we're using allows for 100 redirects, but I'm assuming we will only need redirects for latest, stable, 8.18, 8.19, 9.0 and 9.1, not much more than that?

@miguelgrinberg
Copy link
Contributor Author

miguelgrinberg commented Jan 31, 2025

All pages renamed so that there are no collisions with the redirects. I guess we can wait until the new docs system is in place to see if the redirects above need to be adjusted, and only merge this PR after we put those in.

@miguelgrinberg miguelgrinberg changed the title add DSL module reference documentation to sphinx docs Reorganization of the Sphinx docs to only include reference pages Jan 31, 2025
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