Skip to content

Add basic documentation for Searchable Snapshots REST APIs #54581

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

tlrx
Copy link
Member

@tlrx tlrx commented Apr 1, 2020

This pull request adds basic documentation for the searchable snapshots REST APIs. The main motivations are to not break downstream projects (see #53871) and to provide a simple example of how to mount a snapshot.

It adds a new "Searchable Snapshots APIs" sub section in the REST APIs section. The "Mount Snapshot API" is the more complete documentation and provides an example of how to create a new index backed by a snapshot.

Those API are experimental and marked as such. I've not seen any mention of the license, except the [testenv="basic"] tags that I copied from other doc.

@tlrx tlrx added >docs General docs changes :Distributed Coordination/Snapshot/Restore Anything directly related to the `_snapshot/*` APIs labels Apr 1, 2020
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs (>docs)

@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-distributed (:Distributed/Snapshot/Restore)

@tlrx tlrx requested a review from DaveCTurner April 1, 2020 14:22
@DaveCTurner
Copy link
Contributor

@elasticmachine please run elasticsearch-ci/docs

(the build logs are gone, I can't work out how to see the preview)

Copy link
Contributor

@DaveCTurner DaveCTurner left a comment

Choose a reason for hiding this comment

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

Looks OK as far as I can see; I don't understand why I can't see a preview of these docs from CI however, so we may need to follow up once the docs become properly available.

@tlrx
Copy link
Member Author

tlrx commented Apr 2, 2020

@elasticmachine update branch

@tlrx tlrx merged commit e8cf4f9 into elastic:feature/searchable-snapshots Apr 2, 2020
@tlrx tlrx deleted the add-basic-docs-for-searchable-snapshots branch April 2, 2020 13:15
@tlrx
Copy link
Member Author

tlrx commented Apr 2, 2020

Thanks David!

I don't understand why I can't see a preview of these docs from CI

I did not know that CI was exposing a preview of the docs. I built the docs locally and ran the docs tests, but there's always a room for breaking doc after that :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
:Distributed Coordination/Snapshot/Restore Anything directly related to the `_snapshot/*` APIs >docs General docs changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants