docs(rum): add an SDK versions page - #330
Merged
Merged
Conversation
Every SDK ships on its own schedule with its own version number, and until now a reader had no single place to find out what any of them currently are. The integration guides mostly install without a version, which is right for getting the latest, but leaves nothing to point at when someone needs to pin one. The page links out to each platform's own registry — npm, Maven Central, CocoaPods, ohpm, pub.dev — rather than restating the versions here, so it cannot fall behind what those registries say. It also carries the url scheme for the Web CDN bundles, which have no registry to link to, and warns off the `/browser-sdk/v0/` path: releases moved into a directory per release at v0.1.0, and that older path still resolves while no longer being updated.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Adds
zh/rum/sdk/versions.mdxand its English mirror, registered at the top of the SDK Integration group in both languages.Why
Every SDK ships on its own schedule with its own version number — Android is on
0.6.0while Web is on0.1.0— and a reader had no single place to find out what any of them currently are. The integration guides mostly install without a version, which is right for getting the latest, but leaves nothing to point at when someone needs to pin one.It is also where the
<version>placeholder in the browser-sdk READMEs now sends people (flashcatcloud/browser-sdk#36). The CDN bucket cannot be listed without credentials, so a placeholder there was unresolvable until this page existed.What the page does, and does not, contain
No hardcoded version numbers. The table links to each platform's own registry — npm, Maven Central, CocoaPods, ohpm, pub.dev — so the page cannot fall behind what those registries say. Writing the numbers here would just add one more place to keep in sync, which is the problem this is meant to relieve, not add to.
It does carry the url scheme for the Web CDN bundles, since those have no registry to link to: the directory is the version with a
vprefix, taken from the npm page. And it warns off/browser-sdk/v0/— releases moved into a directory per release at v0.1.0, and that older path still resolves while no longer being updated, so a page still loading it gets an old bundle with no sign anything is wrong.Verification
mint broken-linkspasses.