[App Search] Version documentation links #83245
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
- Was previously just sending (e.g.) "7". instead of "7.9"
- follow WS's example
- except for Enterprise Search setup guide, which should be updated to use a shared URL at some point in any case
cee-chen
added
release_note:skip
cee-chen
commented
Nov 12, 2020
| @@ -8,4 +8,4 @@ import { SemVer } from 'semver'; | |||
| import pkg from '../../../../package.json'; | |||
|
|
|||
| export const CURRENT_VERSION = new SemVer(pkg.version as string); | |||
| export const CURRENT_MAJOR_VERSION = CURRENT_VERSION.major; | |||
| export const CURRENT_MAJOR_VERSION = `${CURRENT_VERSION.major}.${CURRENT_VERSION.minor}`; | |||
There was a problem hiding this comment.
@scottybollinger FYI - links using this const for URLs were previously faulty. They were generating links that looked like
https://www.elastic.co/guide/en/app-search/7/
instead of
https://www.elastic.co/guide/en/app-search/7.9/
I should have fixed it here but let me know if you see any issues.
Also the var name is technically not correct now so IDK if we should change it lol. Is CURRENT_MAJOR_MINOR_VERSION too verbose? Maybe we should do CURRENT_FULL_VERSION and CURRENT_VERSION?
There was a problem hiding this comment.
Will just leave this var name for now but let me know if you want to change this and I'll open a new PR
gmmorris
added a commit
to gmmorris/kibana
that referenced
this pull request
Nov 12, 2020
* master:
[Ingest Manager] Lift up registry/{stream,extract} functions (elastic#83239)
[Reporting] Move "common" types and constants to allow cross-plugin integration (elastic#83198)
[Lens] Add suffix formatter (elastic#82852)
[App Search] Version documentation links (elastic#83245)
Use saved object references for dashboard drilldowns (elastic#82602)
Btsymbala/registered av (elastic#81910)
[APM] Errors table for service overview (elastic#83065)
cee-chen
pushed a commit
that referenced
this pull request
Nov 12, 2020
* Fix CURRENT_MAJOR_VERSION for use in Elastic docs links - Was previously just sending (e.g.) "7". instead of "7.9" * Add App Search DOCS_PREFIX constant - follow WS's example * Update all App Search doc links to use prefixed URLs - except for Enterprise Search setup guide, which should be updated to use a shared URL at some point in any case
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
Adds a DRY version prefix to our outgoing App Search documentation URLs. I believe @chriscressman noted that we should be versioning our doc URLs going forward (instead of using
current) so that older users land up on the correct docs and don't get dead links.Workplace Search is currently already doing this, so we're just catching up/copying them 🐒
QA
8.0in the URL for7.9or7.10and get a working doc page.