Release/1.2 by QuintinWillison · Pull Request #843 · ably/docs

QuintinWillison · 2020-03-23T17:27:52Z

Make 1.2 the current version, ensuring that 1.1 versions are accessible (where applicable).

…since 1.1.

…-Version for REST (RSC7a).

Command used, from content/client-lib-development-guide: git diff v1.1-as-amended:./features.textile ./features.textile > ./versions/features-1-1__1-2.diff

…lative to root. I had accidentally asked nanoc to compile the site from a sub-folder but it took me a while to work out that this had created a transitory crash.log file for me in that folder. It's easier for developers to spot this kind of mistake if they'll see a new file pop up in that scenario.

…s in an old version snapshot file.

SimonWoolf

Note that the v=1.2 with sse examples won't work until we make that change in realtime to make them work. And also reactor events currently default to v=1.0, not 1.2.

QuintinWillison · 2020-03-31T09:50:24Z

Thanks @SimonWoolf - I guess this ties in with #845 which I think I'll get merged first anyway, given it amends docs repository state for 1.1.

What goes first at this stage in terms of getting those realtime changes made, if in light of @mattheworiordan's #845 PR they still need to be made? Can we get this release merged to bleeding edge docs via master branch or should the realtime changes be made first, if they are to be made at all? And if they are not going to be made then presumably I need to revert some of the changes I made in this PR.

tcard · 2020-04-01T13:34:30Z

@QuintinWillison Shouldn't this be deployed to docs.ably.io?

QuintinWillison · 2020-04-01T17:43:40Z

Hi @tcard. Yes, it's live. Happens automatically once it lands on master branch.

tcard · 2020-04-01T18:47:49Z

I commented because I was seeing 1.1 on docs.ably.io, but refreshing fixed that, so I guess it was cached or something. Sorry for the noise.

SimonWoolf · 2020-04-01T22:20:35Z

As discussed on slack the diff is wrong, looks like it's from 1.1-as-amended to 1.2 when it should be from 1.1 to 1.2 - ie should include all the changes that have been added to the 1.1 spec since its initial release, which are required for 1.2 compliance per https://github.com/ably/docs/#branch-and-tag-scheme-for-features-spec.

Apologies for not picking up on this during my PR review on monday

mattheworiordan · 2020-04-01T22:27:25Z

 x-ably-message-id: {UNIQUE_ABLY_MESSAGE_ID}
 x-ably-message-timestamp: {TIMESTAMP_ORIGINAL_MESSAGE_WAS_SENT}
-x-ably-version: 1.0
+x-ably-version: 1.2


@SimonWoolf is this correct? Will the Reactor rules use a 1.2 now?

Not yet, as I mentioned in my review of this pr. I'm planning to change the default for new rules, per the new versioning policy. (TBH I still think this change is unnecessary and that changing the version without there being any actual difference is confusing to customers, but I've already lost that argument 🙂)

mattheworiordan · 2020-04-01T22:27:36Z

 - x-ably-envelope-appid := the "app ID":https://support.ably.io/support/solutions/articles/3000063083 which the message came from
 - content-type := the type of the payload. This will be @application/json@ or @application/x-msgpack@
- x-ably-version := the version of Reactor Event. At present this should be @1.0@, though older Events will be @0.8@
+- x-ably-version := the version of Reactor Event. At present this should be @1.2@


As above...

mattheworiordan · 2020-04-01T22:27:51Z


 ```[javascript]
-var querystring = 'v=1.1&channels={{RANDOM_CHANNEL_NAME}}&rewind=1&key={{API_KEY}}';
+var querystring = 'v=1.2&channels={{RANDOM_CHANNEL_NAME}}&rewind=1&key={{API_KEY}}';


Does SSE suport 1.2?

Not yet, as I mentioned in my review of this pr

mattheworiordan · 2020-04-01T22:31:44Z

I am afraid we have an issue here with this PR in that we've effectively skipped a version now in the docs:

This is important because if someone is now using 1.1, what docs do they refer to? The process we followed before was to simply copy the files into a 1.1 versions folder, and voila, you magically have 1.1.

We need to do this I am afraid.

Also, this has been merged in master, which means if anyone now merges other changes in the docs repo (@fliptopbox is doing work on tutorials), we will now be showing 1.2 on the website. Did we intend to do that before we actually release 1.2 libraries?

What's the plan for release of all 1.2 libraries too i.e. we should bump all libraries I assume to 1.2 even if they don't necessarily change so that we have a set of 1.2 libraries, and the features doc is updated to confirm what features are missing from which libs for 1.2 specific things.

QuintinWillison · 2020-04-06T05:54:20Z

@mattheworiordan can you please be specific regarding your statement "we've effectively skipped a version now in the docs". For what I was able to work out from inspecting the existing repository, the commits going towards the previous 1.1 release by @tomczoink, the Ruby 'versions helper' code in this repository and from adhoc input I've had from @SimonWoolf my work to get us to a state of having docs ready for 1.2 was complete. So what did I miss?

Your example screenshot above is from a page that did not need to change between 1.0 and 1.2 docs - so why do you assert it needs an entry in the drop down for 1.1?

The only two pages that have changed are channel params:

and the features spec:

I don't know what more work needs doing on this repository so can you either be more specific about what work still remains or perhaps push some commits yourself, please?

FYI, @paddybyers

mattheworiordan · 2020-04-06T17:59:00Z

Moving this conversation out of here as there is an open issue #854

mattheworiordan temporarily deployed to ably-docs-staging-pr-843 March 23, 2020 17:28 Inactive

QuintinWillison force-pushed the release/1.2 branch from b12a56e to 03b6c0aCompare March 23, 2020 18:05

mattheworiordan temporarily deployed to ably-docs-staging-pr-843 March 23, 2020 18:05 Inactive

mattheworiordan temporarily deployed to ably-docs-staging-pr-843 March 23, 2020 19:25 Inactive

mattheworiordan temporarily deployed to ably-docs-staging-pr-843 March 23, 2020 19:42 Inactive

mattheworiordan temporarily deployed to ably-docs-staging-pr-843 March 25, 2020 12:20 Inactive

mattheworiordan had a problem deploying to ably-docs-staging-pr-843 March 25, 2020 15:27 Failure

QuintinWillison marked this pull request as ready for review March 30, 2020 06:20

QuintinWillison requested review from SimonWoolf, paddybyers and tomczoink March 30, 2020 06:20

Quintin Willison added 13 commits March 30, 2020 09:25

Update current version to 1.2 and freeze the pages that have changed …
359f184
…since 1.1.

Update current API version in the features spec (G4) including X-Ably…
d7fe83a
…-Version for REST (RSC7a).

Create features spec diff from 1.1 to 1.2.
cac5779
Command used, from content/client-lib-development-guide: git diff v1.1-as-amended:./features.textile ./features.textile > ./versions/features-1-1__1-2.diff

Add link to the 1.1 to 1.2 features spec diff to the features spec.
e6205c2

Remove beta caveat from code commentary.
0cc1974

Update the root docs gem spec version.
2a3f24c

Update Java and Android library version references.
697bd5f

Update JavaScript library version references.
8e8a7aa

Update X-Ably-Version headers.
2d15a8e

Update version number in query strings.
ace9d4f

Update version number in SSE docs for the v query param.
e031367

Revert version increment that should have not been done because it wa…
5acd479
…s in an old version snapshot file.

QuintinWillison force-pushed the release/1.2 branch from bd6f857 to 5acd479Compare March 30, 2020 08:25

mattheworiordan had a problem deploying to ably-docs-staging-pr-843 March 30, 2020 08:25 Failure

SimonWoolf approved these changes Mar 30, 2020
View reviewed changes

Update JSBin pointers.
f10e77f

mattheworiordan temporarily deployed to ably-docs-staging-pr-843 March 31, 2020 14:45 Inactive

QuintinWillison mentioned this pull request Apr 1, 2020
Address 1.2 API version sync in examples #848
Closed

QuintinWillison merged commit 0ca060f into masterApr 1, 2020

QuintinWillison deleted the release/1.2 branch April 1, 2020 10:51

mattheworiordan reviewed Apr 1, 2020
View reviewed changes

This was referenced Apr 2, 2020
1.2 has been released prematurely and 1.1 docs are missing #854
Closed
Version 1.2 #856
Closed

tomczoink mentioned this pull request Apr 15, 2020
Updated client lib spec to v1.2 #870
Merged

Uh oh!

Conversation

QuintinWillison commented Mar 23, 2020

Uh oh!

SimonWoolf left a comment

Choose a reason for hiding this comment

Uh oh!

QuintinWillison commented Mar 31, 2020

Uh oh!

tcard commented Apr 1, 2020

Uh oh!

QuintinWillison commented Apr 1, 2020

Uh oh!

tcard commented Apr 1, 2020

Uh oh!

SimonWoolf commented Apr 1, 2020

Uh oh!

mattheworiordanApr 1, 2020

Choose a reason for hiding this comment

Uh oh!

SimonWoolfApr 1, 2020• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mattheworiordanApr 1, 2020

Choose a reason for hiding this comment

Uh oh!

mattheworiordanApr 1, 2020

Choose a reason for hiding this comment

Uh oh!

SimonWoolfApr 1, 2020

Choose a reason for hiding this comment

Uh oh!

mattheworiordan commented Apr 1, 2020

Uh oh!

QuintinWillison commented Apr 6, 2020• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mattheworiordan commented Apr 6, 2020

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

4 participants

SimonWoolfApr 1, 2020•
edited
Loading

QuintinWillison commented Apr 6, 2020•
edited
Loading