Release 0.8.3 docs: README + CDN references - #109
Merged
Conversation
The README's Version and Change Log sections stopped at 0.8.1 -- 0.8.2 was never added, so this fills that gap as well as adding 0.8.3. The CDN examples in quickstart.md and client-usage.md pinned 0.8.1 as "current". Bumped to 0.8.3 and listed 0.8.2/0.8.1 as the intermediate pins. Added a note that pinning means not picking up fixes automatically, with 0.8.3 as the concrete example -- pinned integrations on 0.8.0-0.8.2 cannot connect Medical Mutual or SimplePay Health at all. Also corrected "Three CDN forms are supported" -- there were already four, and this makes six. ORDERING: these docs advertise sdk-v-0.8.3.js, which does not exist until the CDN bake lands in the stream repo (package.json alias + assets/sdk_cdn/sdk-cdn-v083.jsx + webpack.common-sdk-cdn.js entry). Land that first, or this documents a 404.
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.
Docs-only follow-up to #107 / #108. No code, no version bump — 0.8.3 is already published to npm and tagged
v0.8.3.Dev PR: LakeEriePartners/stream-connect-js-sdk#10.
README
The
## Versionand## Change Logsections had stalled at 0.8.1. 0.8.2 was never added, so this fills that pre-existing gap as well as adding 0.8.3. The version ladder now runs 0.8.3 → 0.8.2 → 0.8.1 → 0.8.0 in both sections.CDN references
docs/quickstart.mdanddocs/client-usage.mdboth pinnedsdk-v-0.8.1.jsas the current version. Bumped to 0.8.3, and the supported-forms list now includes the 0.8.2 and 0.8.1 pins that were missing. Also corrected "Three CDN forms are supported" — there were already four listed, and this makes six.Added an explicit note that pinning means not picking up fixes automatically, using 0.8.3 as the concrete case: a pinned integration on 0.8.0–0.8.2 cannot connect Medical Mutual or SimplePay Health at all. Pinned integrations are precisely the ones that don't get this fix for free, so it's worth stating plainly.
Ordering
These docs advertise
https://app.tpastream.com/static/js/sdk-v-0.8.3.js. That build is created by the CDN bake in thestreamrepo (LakeEriePartners/stream#15083), which is open but not yet merged — until it deploys, the pinned 0.8.3 URL 404s.This matters here because
developer-docsclones this repo'sdocs/at docusaurus build time, so merging propagates to the public docs site on the next build. If that's likely to happen before the CDN bake deploys, hold this PR until #15083 is out.The floating
sdk.jspointer referenced throughout the docs is unaffected either way, and is how the overwhelming majority of CDN traffic loads the SDK (10,236 requests vs 42 for all pinned builds combined, over the last 14 days).