[DOCS] Note doc links should be live in REST API JSON specs #53871
+6
−1
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Downstream Elasticsearch clients, such as the Elaticsearch-JS client, use the documentation links in our REST API JSON specifications to create their docs. Using a broken link or linking to yet-to-be-created doc pages can break the docs build for these clients. This PR adds a related note to the README for the REST API JSON Specs.
|
Pinging @elastic/es-docs (>docs) |
szabosteve
approved these changes
Mar 20, 2020
jrodewig
added a commit
that referenced
this pull request
Mar 23, 2020
Downstream Elasticsearch clients, such as the Elaticsearch-JS client, use the documentation links in our REST API JSON specifications to create their docs. Using a broken link or linking to yet-to-be-created doc pages can break the docs build for these clients. This PR adds a related note to the README for the REST API JSON Specs.
jrodewig
added a commit
that referenced
this pull request
Mar 23, 2020
Downstream Elasticsearch clients, such as the Elaticsearch-JS client, use the documentation links in our REST API JSON specifications to create their docs. Using a broken link or linking to yet-to-be-created doc pages can break the docs build for these clients. This PR adds a related note to the README for the REST API JSON Specs.
jrodewig
added a commit
that referenced
this pull request
Mar 23, 2020
Downstream Elasticsearch clients, such as the Elaticsearch-JS client, use the documentation links in our REST API JSON specifications to create their docs. Using a broken link or linking to yet-to-be-created doc pages can break the docs build for these clients. This PR adds a related note to the README for the REST API JSON Specs.
tlrx
added a commit
that referenced
this pull request
Apr 2, 2020
This commit 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.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Downstream Elasticsearch clients, such as the Elaticsearch-JS client,
use the documentation links in our REST API JSON specifications to
create their docs.
Using a broken link or linking to yet-to-be-created doc pages can
break the docs build for these clients.
This PR adds a related note to the README for the REST API JSON Specs.