Skip to content
This repository was archived by the owner on Aug 10, 2026. It is now read-only.

Deltas documentation - #880

Merged
tomczoink merged 49 commits into
docs-v1.2-changesfrom
deltas-additions
Jun 9, 2020
Merged

Deltas documentation#880
tomczoink merged 49 commits into
docs-v1.2-changesfrom
deltas-additions

Conversation

@tomczoink

@tomczoinktomczoink commented May 5, 2020•
edited
Loading

Copy link
Copy Markdown
Contributor

This PR introduces Deltas documentation, in addition to a re-structure of our existing Channel Params section.

Mark will be updating content.

@tomczoink
Add new structure for realtime/channel details
a3e847d
Adds sub-directories for realtime/channels containing pages pertaining to channels, namely channel parameters and channel metadata.
@mattheworiordan
mattheworiordan temporarily deployed to ably-docs-deltas-additi-vqsver May 5, 2020 16:15 Inactive
@MarkWoulfeAblyMarkWoulfeAbly mentioned this pull request May 12, 2020
Closed
MarkWoulfeAbly
MarkWoulfeAbly reviewed May 19, 2020
View reviewed changes
Comment threadcontent/realtime/channels/overview.textile Outdated
MarkWoulfeAbly
MarkWoulfeAbly reviewed May 19, 2020
View reviewed changes
Comment threadcontent/realtime/channels/overview.textile
MarkWoulfeAbly
MarkWoulfeAbly reviewed May 20, 2020
View reviewed changes
Comment threadcontent/realtime/channels/channel-parameters/overview.textile
MarkWoulfeAbly
MarkWoulfeAbly reviewed May 21, 2020
View reviewed changes
Comment threadcontent/realtime/channels/channel-parameters/deltas.textile Outdated
MarkWoulfeAbly
MarkWoulfeAbly reviewed May 22, 2020
View reviewed changes
Comment threadcontent/realtime/channels/channel-parameters/deltas.textile Outdated
@MarkWoulfeAbly
Updated channel parameter example
6a252c1
Updated the example to include delta as well as rewind.
MarkWoulfeAbly
MarkWoulfeAbly reviewed May 22, 2020
View reviewed changes

@MarkWoulfeAblyMarkWoulfeAbly left a comment •
edited
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ignore this

MarkWoulfeAbly
MarkWoulfeAbly reviewed May 22, 2020
View reviewed changes
Comment threadcontent/realtime/channels/overview.textile
mattheworiordan
mattheworiordan suggested changes May 29, 2020
View reviewed changes

@mattheworiordanmattheworiordan left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@MarkWoulfeAbly I like the idea of an overview page, but I don't follow why a URL change is necessary to do this. This will break every link we have to these docs, and I am not sure what the benefit of this is.

I have provided a lot of feedback in this PR. Perhaps a call is best to run through this all to give you more context.

Comment threadcontent/core-features/versions/v1.1/pubsub.textile Outdated
Comment threadcontent/general/versions/v0.8/queues.textile Outdated
Comment threadcontent/general/versions/v1.0/firehose.textile Outdated
Comment threadcontent/realtime/channels/overview.textile
Comment threadcontent/realtime/channels/channel-parameters/deltas.textile Outdated
Comment threadcontent/realtime/channels/channel-parameters/rewind.textile Outdated
Comment threadcontent/realtime/channels/channel-parameters/deltas.textile Outdated
Comment threadcontent/realtime/channels/overview.textile Outdated
Comment threadcontent/realtime/channels/overview.textile
Comment threadcontent/realtime/channels/channel-parameters/rewind.textile
@QuintinWillison

QuintinWillison commented Jun 2, 2020

Copy link
Copy Markdown
Contributor

@MarkWoulfeAbly looking at the number of queries as well as the amount of example code that either diverges from the examples I put together or appears to have questionable divinity, I'm going to put together a PR targeting this branch to bring all the example code up to spec..

@tomczoinktomczoink changed the title Add new structure for realtime/channel detailsDeltas documentationJun 2, 2020
@tomczoink
Added delta JSBin code samples
e164484
@tomczoink
Updated deltas code samples
96128ca
@tomczoink
Shorted deltas code sample
2940a0b
@tomczoink
Const/let to var in channel parameter code snippets
bfd02c2
Also adds [js] to end of some code snippets missing it
@tomczoink
Various code fixes and additions for channel-parameters
4a4bbf6
- Add missing code snippets throughout channel parameters sections
- Added a few TBD code snippet locations, to be filled once we have them
- Fixed a stray " in java snippets
- Added language specification in pages
@tomczoink
Removed triple spaces in channel-parameters docs
45e4d35
@tomczoink
Corrected MQTT code example from JS to nodejs
17afcc2
paddybyers
paddybyers reviewed Jun 8, 2020
View reviewed changes
Comment threadcontent/realtime/channels/channel-parameters/overview.textile Outdated
@mattheworiordan
mattheworiordan temporarily deployed to ably-docs-deltas-additi-esrf5z June 8, 2020 15:38 Inactive
@twist900
twist900 temporarily deployed to ably-docs-deltas-additi-pgzg1y June 8, 2020 15:51 Inactive
@mattheworiordan
mattheworiordanhad a problem deploying to ably-docs-deltas-additi-3fhpjv June 8, 2020 16:03 Failure
@tomczoink
tomczoink temporarily deployed to ably-docs-deltas-additi-3fhpjv June 8, 2020 16:04 Inactive
@tomczoink
Correct api ref in channel parameters for csharp
58a2263
Incorrectly said REST rather than realtime
@mattheworiordan
mattheworiordan temporarily deployed to ably-docs-deltas-additi-eo3usj June 8, 2020 16:07 Inactive
@kennethkalmer
kennethkalmer temporarily deployed to ably-docs-deltas-additi-kshvbm June 8, 2020 16:21 Inactive
@kennethkalmer
kennethkalmer temporarily deployed to ably-docs-deltas-additi-dytcmf June 8, 2020 16:46 Inactive
@mattheworiordan
mattheworiordan temporarily deployed to ably-docs-deltas-additi-7bna5c June 8, 2020 16:56 Inactive
@mattheworiordan
mattheworiordan temporarily deployed to ably-docs-deltas-additi-eyvewr June 9, 2020 08:49 Inactive
@mattheworiordan
mattheworiordan temporarily deployed to ably-docs-deltas-additi-hyqubu June 9, 2020 09:02 Inactive
@mattheworiordan
mattheworiordan temporarily deployed to ably-docs-deltas-additi-l8ndqs June 9, 2020 09:06 Inactive
@mattheworiordan
mattheworiordan temporarily deployed to ably-docs-deltas-additi-sevbth June 9, 2020 09:28 Inactive
@mattheworiordan
mattheworiordan temporarily deployed to ably-docs-deltas-additi-z8zyx0 June 9, 2020 10:35 Inactive
@mattheworiordan
mattheworiordan temporarily deployed to ably-docs-deltas-additi-bcmpsn June 9, 2020 11:16 Inactive
@tomczoink
tomczoink merged commit 1f699f2 into docs-v1.2-changesJun 9, 2020
@tomczoink
tomczoink deleted the deltas-additions branch June 9, 2020 11:29
tomczoink added a commit that referenced this pull request Jun 9, 2020
@tomczoinkMark Woulfe
@MarkWoulfeAbly@kennethkalmer
Deltas documentation (#880)
3825450
Added deltas documentation, and restructured Channel Parameter sections.
Co-authored-by: Mark Woulfe <markwoulfe@MacBook-Pro.local>
Co-authored-by: MarkWoulfeAbly <63646324+MarkWoulfeAbly@users.noreply.github.com>
Co-authored-by: Mark Woulfe <mark.woulfe@ably.com>
Co-authored-by: Kenneth Kalmer <kenneth@ably.com>
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

7 more reviewers
@mattheworiordanmattheworiordanmattheworiordan requested changes
@paddybyerspaddybyerspaddybyers left review comments
@kavalerovkavalerovkavalerov left review comments
@SimonWoolfSimonWoolfSimonWoolf left review comments
@QuintinWillisonQuintinWillisonQuintinWillison left review comments
@remotekieranremotekieranremotekieran left review comments
@MarkWoulfeAblyMarkWoulfeAblyMarkWoulfeAbly left review comments
Reviewers whose approvals may not affect merge requirements

Assignees

@MarkWoulfeAblyMarkWoulfeAbly

Labels

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

10 participants

@tomczoink@QuintinWillison@mattheworiordan@paddybyers@kavalerov@SimonWoolf@remotekieran@MarkWoulfeAbly@kennethkalmer@twist900