[DOCS] Add redirects for missing data stream API docs #53866
Merged
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
Collaborator
|
Pinging @elastic/es-docs (>docs) |
The following API spec files contain a link to a not-yet-created docs page for the data stream APIs: * [indices.create_data_stream.json][0] * [indices.delete_data_stream.jsonn][1] * [indices.get_data_streams.json][2] The Elaticsearch-JS client uses these spec files to create their docs. This created a broken link in the Elaticsearch-JS, which has broken the docs build. This PR adds a temporary redirect for the docs page. This redirect should be removed when the actual API docs are added. [0]: https://github.com/elastic/elasticsearch/blob/master/rest-api-spec/src/main/resources/rest-api-spec/api/indices.create_data_stream.json [1]: https://github.com/elastic/elasticsearch/blob/master/rest-api-spec/src/main/resources/rest-api-spec/api/indices.delete_data_stream.json [2]: https://github.com/elastic/elasticsearch/blob/master/rest-api-spec/src/main/resources/rest-api-spec/api/indices.get_data_streams.json Relates to #53558. CC @martijnvg
martijnvg
approved these changes
Mar 20, 2020
Member
martijnvg
left a comment
martijnvg
left a comment
There was a problem hiding this comment.
LGTM
Thanks for fixing this. I was unaware of the fact that downstream the link actually had to resolve to a real docs page.
I think this should be backported to the 7.x branch too, given the fact that I will backport #53666 either today or on monday.
Contributor
Author
|
Thanks @martijnvg. I'll get this merged and backported to 7.x. |
jrodewig
added a commit
that referenced
this pull request
Mar 20, 2020
The following API spec files contain a link to a not-yet-created docs page for the data stream APIs: * [indices.create_data_stream.json][0] * [indices.delete_data_stream.jsonn][1] * [indices.get_data_streams.json][2] The Elaticsearch-JS client uses these spec files to create their docs. This created a broken link in the Elaticsearch-JS, which has broken the docs build. This PR adds a temporary redirect for the docs page. This redirect should be removed when the actual API docs are added. [0]: https://github.com/elastic/elasticsearch/blob/master/rest-api-spec/src/main/resources/rest-api-spec/api/indices.create_data_stream.json [1]: https://github.com/elastic/elasticsearch/blob/master/rest-api-spec/src/main/resources/rest-api-spec/api/indices.delete_data_stream.json [2]: https://github.com/elastic/elasticsearch/blob/master/rest-api-spec/src/main/resources/rest-api-spec/api/indices.get_data_streams.json Relates to #53558. CC @martijnvg
Contributor
Author
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
The following API spec files contain a link to a not-yet-created
docs page for the data stream APIs:
The Elaticsearch-JS client uses these spec files to create their docs.
This created a broken link in the Elaticsearch-JS, which has broken
the docs build.
This PR adds a temporary redirect for the docs page. This redirect
should be removed when the actual API docs are added.
Relates to #53558.
CC @martijnvg