Docs: Fix the API reference #799
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
Fixes some outbound links in the API reference. These are caused by bad links in Elasticsearch's json spec files. We've filed and issue with Elasticsearch here: elastic/elasticsearch#40596 but for now this works around the bad links.
nik9000
commented
Mar 28, 2019
| if (!str) return '' | ||
| if (str.includes('/5.x/')) { |
There was a problem hiding this comment.
Elasticsearch has all kinds of wrong branches linked and this new replacement forces them all to the "current" branch.
nik9000
commented
Mar 28, 2019
scripts/utils/generateDocs.js
Outdated
| "license.post_start_basic": "{ref}/start-basic.html", | ||
| "license.post_start_trial": "{ref}/start-trial.html", | ||
| "migration.deprecations": "{ref}/migration-api-deprecation.html", | ||
| "monitoring.bulk": "{ref}/es-monitoring.html", |
There was a problem hiding this comment.
Some of these can't be fixed by regex and others would be complex to fix via regex so I do it this way here.
delvedor
pushed a commit
that referenced
this pull request
Mar 29, 2019
delvedor
pushed a commit
that referenced
this pull request
Mar 29, 2019
delvedor
pushed a commit
that referenced
this pull request
Mar 29, 2019
|
I've backported the fix to |
|
Thanks! This seems to have fixed all of the broken links in 7.x and master. There are a few in 6.x and 5.x: I can look at those in a bit. |
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.
Fixes some outbound links in the API reference. These are caused by bad
links in Elasticsearch's json spec files. We've filed and issue with
Elasticsearch here:
elastic/elasticsearch#40596
but for now this works around the bad links.