[doc-links] Ensure correct doc links from main branch #116652
Merged
Conversation
This file contains 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
Until all repos are switched over to using a "main" branch, all the doc URLs are still published as the "master" version. This also gives us a single place to change once we start publishing them as "main".
gtback
added
release_note:skip
|
Pinging @elastic/kibana-docs (Team:Docs) |
|
This should effectively be a no-op for as long as the branch is called "master", so I'm not sure how (if?) to test this. This should be removed when elastic/docs#2264 is addressed. |
gtback
commented
Oct 28, 2021
| const DOC_LINK_VERSION = injectedMetadata.getKibanaBranch(); | ||
| const kibanaBranch = injectedMetadata.getKibanaBranch(); | ||
| // Documentation for `main` branches is still published at a `master` URL. | ||
| const DOC_LINK_VERSION = kibanaBranch === 'main' ? 'master' : kibanaBranch; |
There was a problem hiding this comment.
Theoretically, we could just hard-code DOC_LINK_VERSION to "main", since we're not going to backport this change, and should ideally remove it before new versions get branched off of this.
10 tasks
tylersmalley
approved these changes
Oct 28, 2021
💚 Build Succeeded
Metrics [docs]Page load bundle
To update your PR or re-run it, just comment with: |
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.
Summary
Until all repos are switched over to using a "main" branch, all the doc
URLs are still published as the "master" version. This also gives us a
single place to change once we start publishing them as "main".
For maintainers