-
Notifications
You must be signed in to change notification settings - Fork 56
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[ECO-1416] Add migration guide for v2 #1670
[ECO-1416] Add migration guide for v2 #1670
Conversation
65f0c1e
to
9a3cfaf
Compare
a57271c
to
a9bf9e8
Compare
cde2b5e
to
eac56cf
Compare
281e17a
to
a224cdd
Compare
2ff6a7c
to
98e8ede
Compare
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)
98e8ede
to
da506cc
Compare
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
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
a75e9c8
to
5568fcc
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. (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
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM! I'm happy to merge once all remaining conversations are resolved and [skip ci]
is removed.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Like it!
Owen’s away and indicated he's happy for me to resolve his comments.
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
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
c79f906
to
b44e629
Compare
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.