[ECO-1416] Add migration guide for v2#1670
Merged
Merged
Conversation
10 tasks
github-actions
Bot
temporarily deployed
to
staging/pull/1670/bundle-report
lawrence-forooghian
force-pushed
the
ECO-1416-v2-migration-guide
branch
from
65f0c1e to
9a3cfaf
Compare
github-actions
Bot
temporarily deployed
to
staging/pull/1670/bundle-report
VeskeR
force-pushed
the
1604/v2-changelog
branch
3 times, most recently
from
a57271c to
a9bf9e8
Compare
lawrence-forooghian
force-pushed
the
ECO-1416-v2-migration-guide
branch
2 times, most recently
from
cde2b5e to
eac56cf
Compare
github-actions
Bot
temporarily deployed
to
staging/pull/1670/bundle-report
github-actions
Bot
temporarily deployed
to
staging/pull/1670/bundle-report
lawrence-forooghian
force-pushed
the
ECO-1416-v2-migration-guide
branch
10 times, most recently
from
281e17a to
a224cdd
Compare
lawrence-forooghian
force-pushed
the
ECO-1416-v2-migration-guide
branch
from
14eb863 to
d435e38
Compare
owenpearson
previously requested changes
Mar 20, 2024
lawrence-forooghian
force-pushed
the
ECO-1416-v2-migration-guide
branch
from
d435e38 to
c622f71
Compare
lawrence-forooghian
added a commit
to ably/sdk-api-reference
that referenced
this pull request
Mar 20, 2024
There is no longer a concept of a "major" version; as of protocol version 2, the protocol version is a single integer (see spec point CSV2a). Unfortunately, the linked ably.com REST API versioning documentation still refers to API versions 1.1 and 1.2, but that’s a separate issue — the REST API documentation needs to be versioned and updated for newer protocol versions, which Mark says is planned. Relevant conversation in [1], where Mark says: > For the docstring I think we can drop "major" and just refer to it as > "version" since this will be the case going forwards. We can leave the > link in for now too even if it'll be a little wonky until we release the > versioned REST API. [1] ably/ably-js#1670 (comment)
lawrence-forooghian
force-pushed
the
ECO-1416-v2-migration-guide
branch
4 times, most recently
from
2ff6a7c to
98e8ede
Compare
lawrence-forooghian
added a commit
that referenced
this pull request
Mar 20, 2024
Based on e71ed5f...c64732c. Note that 1.2.50, to which this guide refers, doesn't exist yet. We’ll do that in #1672. HTML tags used for headings so that I can specify a fixed `id` to use in fragment links, because I’m probably going to keep editing the headings and so if I rely on the generated headings then I’ll almost certainly end up with a broken link. (GitHub doesn’t seem to support the custom heading ID syntax described in [1].) And we don’t have a linter that checks for broken fragment links. The description of the stats response changes comes from Simon in [2]. Resolves ECO-1416. (TODO remove) Skipping CI whilst editing this, to avoid loads of pointless test runs; will undo once editing done: [skip ci] [1] https://www.markdownguide.org/extended-syntax/#heading-ids [2] #1670 (comment)
lawrence-forooghian
force-pushed
the
ECO-1416-v2-migration-guide
branch
from
98e8ede to
da506cc
Compare
lawrence-forooghian
added a commit
that referenced
this pull request
Mar 20, 2024
Based on e71ed5f...c64732c. Note that 1.2.50, to which this guide refers, doesn't exist yet. We’ll do that in #1672. The description of the stats response changes comes from Simon in [1]. HTML tags used for headings so that I can specify a fixed `id` to use in fragment links, because I’m probably going to keep editing the headings and so if I rely on the generated headings then I’ll almost certainly end up with a broken link. (GitHub doesn’t seem to support the custom heading ID syntax described in [2].) And we don’t have a linter that checks for broken fragment links. Resolves ECO-1416. (TODO remove) Skipping CI whilst editing this, to avoid loads of pointless test runs; will undo once editing done: [skip ci] [1] #1670 (comment) [2] https://www.markdownguide.org/extended-syntax/#heading-ids
lawrence-forooghian
force-pushed
the
ECO-1416-v2-migration-guide
branch
from
da506cc to
a75e9c8
Compare
(It’s already in `format`).
I’ll add the v2 migration guide for the library at docs/migration-guides/v2/lib.md. And then in #1672 I anticipate Andrii adding the v2 migration guide for React Hooks at docs/migration-guides/v2/react-hooks.md.
Taken from sdk-api-reference commit 7cc5a28 (see [1], not merged yet). [1] ably/sdk-api-reference#40
lawrence-forooghian
force-pushed
the
ECO-1416-v2-migration-guide
branch
from
a75e9c8 to
5568fcc
Compare
lawrence-forooghian
added a commit
that referenced
this pull request
Mar 20, 2024
Based on e71ed5f...2e12459. Note that 1.2.50, to which this guide refers, doesn't exist yet. We’ll do that in #1672. The description of the stats response changes comes from Simon in [1], and the description of the removal of connection upgrades comes from Owen in [2]. HTML tags used for headings so that I can specify a fixed `id` to use in fragment links, because I’m probably going to keep editing the headings and so if I rely on the generated headings then I’ll almost certainly end up with a broken link. (GitHub doesn’t seem to support the custom heading ID syntax described in [3].) And we don’t have a linter that checks for broken fragment links. Resolves ECO-1416. (TODO remove) Skipping CI whilst editing this, to avoid loads of pointless test runs; will undo once editing done: [skip ci] [1] #1670 (comment) [2] #1670 (comment) [3] https://www.markdownguide.org/extended-syntax/#heading-ids
VeskeR
approved these changes
Mar 20, 2024
lawrence-forooghian
dismissed
owenpearson’s stale review
Owen’s away and indicated he's happy for me to resolve his comments.
lawrence-forooghian
added a commit
that referenced
this pull request
Mar 21, 2024
Based on e71ed5f...2e12459. Note that 1.2.50, to which this guide refers, doesn't exist yet. We’ll do that in #1672. The description of the stats response changes comes from Simon in [1], and the description of the removal of connection upgrades comes from Owen in [2]. HTML tags used for headings so that I can specify a fixed `id` to use in fragment links, because I’m probably going to keep editing the headings and so if I rely on the generated headings then I’ll almost certainly end up with a broken link. (GitHub doesn’t seem to support the custom heading ID syntax described in [3].) And we don’t have a linter that checks for broken fragment links. Resolves ECO-1416. [1] #1670 (comment) [2] #1670 (comment) [3] https://www.markdownguide.org/extended-syntax/#heading-ids
lawrence-forooghian
force-pushed
the
ECO-1416-v2-migration-guide
branch
from
5568fcc to
c79f906
Compare
Based on e71ed5f...2e12459. Note that 1.2.50, to which this guide refers, doesn't exist yet. We’ll do that in #1672. The description of the stats response changes comes from Simon in [1], and the description of the removal of connection upgrades comes from Owen in [2]. HTML tags used for headings so that I can specify a fixed `id` to use in fragment links, because I’m probably going to keep editing the headings and so if I rely on the generated headings then I’ll almost certainly end up with a broken link. (GitHub doesn’t seem to support the custom heading ID syntax described in [3].) And we don’t have a linter that checks for broken fragment links. Resolves ECO-1416. [1] #1670 (comment) [2] #1670 (comment) [3] https://www.markdownguide.org/extended-syntax/#heading-ids
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
6 participants
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.
WIP in that I’m sure there will be some editing needed, but it’s ready for some eyes on it. I’m also adding @m-hulbert to take a look, since this is an important piece of user-facing documentation.
There's a couple of uninteresting formatting commits, and then the migration guide itself is in the final commit; see that commit message for more details.
Resolves ECO-1416.