Skip to content
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

[DTP-732] - Create LiveSync Quickstart page #2184

Merged
merged 7 commits into from
Jun 10, 2024

Conversation

GregHolmes
Copy link
Contributor

Description

This PR is a further improvement to the LiveSync docs for the Alpha release of the product. This contains a Quickstart page.

NOTE TO REVIEWERS - This PR is based on the current DTP-707 PR, when DTP-707 is release (if this isn't approved before hand) I'll update to base on main.

@GregHolmes GregHolmes changed the title [DTP-732] - Create Quickstart page [DTP-732] - Create LiveSync Quickstart page May 13, 2024
@ably-ci ably-ci temporarily deployed to ably-docs-dtp-732-creat-pmiwib May 13, 2024 15:41 Inactive
Base automatically changed from DTP-707-Implement-new-IA-for-LiveSync-docs to main May 14, 2024 16:25
@Srushtika Srushtika self-requested a review May 20, 2024 16:10
@Srushtika Srushtika temporarily deployed to ably-docs-dtp-732-creat-f3gxlv May 20, 2024 16:14 Inactive
Copy link
Member

@Srushtika Srushtika left a comment

Choose a reason for hiding this comment

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

Hi @GregHolmes , I've added a few comments wrt the structure of the quickstart guide. Worth looking into those and I can do a fresh round of review.

content/livesync/how-livesync-works.textile Outdated Show resolved Hide resolved
content/livesync/quickstart.textile Outdated Show resolved Hide resolved
content/livesync/quickstart.textile Outdated Show resolved Hide resolved
content/livesync/quickstart.textile Outdated Show resolved Hide resolved
content/livesync/quickstart.textile Outdated Show resolved Hide resolved
content/livesync/quickstart.textile Outdated Show resolved Hide resolved
content/livesync/quickstart.textile Outdated Show resolved Hide resolved
content/livesync/quickstart.textile Outdated Show resolved Hide resolved
content/livesync/quickstart.textile Outdated Show resolved Hide resolved
content/livesync/quickstart.textile Outdated Show resolved Hide resolved
@GregHolmes GregHolmes force-pushed the DTP-732-Create-Quickstart-page branch from d66e696 to 19c8c89 Compare May 22, 2024 07:40
@GregHolmes GregHolmes temporarily deployed to ably-docs-dtp-732-creat-f3gxlv May 22, 2024 07:40 Inactive
@GregHolmes GregHolmes temporarily deployed to ably-docs-dtp-732-creat-f3gxlv May 22, 2024 07:41 Inactive
@GregHolmes GregHolmes temporarily deployed to ably-docs-dtp-732-creat-f3gxlv May 22, 2024 09:07 Inactive
@GregHolmes GregHolmes temporarily deployed to ably-docs-dtp-732-creat-f3gxlv May 22, 2024 09:12 Inactive
@GregHolmes GregHolmes temporarily deployed to ably-docs-dtp-732-creat-f3gxlv May 22, 2024 11:06 Inactive
@GregHolmes GregHolmes temporarily deployed to ably-docs-dtp-732-creat-f3gxlv May 23, 2024 11:06 Inactive
Copy link

@mschristensen mschristensen left a comment

Choose a reason for hiding this comment

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

Thanks Greg - as requested by @Srushtika the example has now been moved to its own repo: https://github.com/ably-labs/live-comments

So some changes required to align with that. I also changed the implementation of how we subscribe to the model to do it the same was as we do in the livesync example which handles model subscribe/unsubscribe better

content/livesync/quickstart.textile Outdated Show resolved Hide resolved
content/livesync/quickstart.textile Outdated Show resolved Hide resolved
content/livesync/quickstart.textile Outdated Show resolved Hide resolved
content/livesync/quickstart.textile Outdated Show resolved Hide resolved
content/livesync/quickstart.textile Outdated Show resolved Hide resolved
@GregHolmes GregHolmes force-pushed the DTP-732-Create-Quickstart-page branch from c2f3c71 to 599bdd8 Compare May 29, 2024 09:16
@GregHolmes
Copy link
Contributor Author

Thanks Greg - as requested by @Srushtika the example has now been moved to its own repo: https://github.com/ably-labs/live-comments

So some changes required to align with that. I also changed the implementation of how we subscribe to the model to do it the same was as we do in the livesync example which handles model subscribe/unsubscribe better

Thanks @mschristensen I've updated these.
But now I need to go back and make the change from self hosted to hosted DB connector. Will let you know once I'm done.

Copy link

@mschristensen mschristensen left a comment

Choose a reason for hiding this comment

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

Looks good, minor comment on some unused env vars, once addressed this looks good. Thanks Greg

content/livesync/quickstart.textile Outdated Show resolved Hide resolved
@GregHolmes GregHolmes temporarily deployed to ably-docs-dtp-732-creat-izlioz June 5, 2024 11:02 Inactive
@GregHolmes GregHolmes temporarily deployed to ably-docs-dtp-732-creat-izlioz June 5, 2024 14:46 Inactive
@GregHolmes GregHolmes force-pushed the DTP-732-Create-Quickstart-page branch from 2e1a860 to e461b24 Compare June 5, 2024 14:53
@GregHolmes GregHolmes had a problem deploying to ably-docs-dtp-732-creat-izlioz June 5, 2024 14:53 Failure
Copy link
Member

@Srushtika Srushtika left a comment

Choose a reason for hiding this comment

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

Thanks @GregHolmes - I've added some comments

content/livesync/quickstart.textile Outdated Show resolved Hide resolved
content/livesync/quickstart.textile Outdated Show resolved Hide resolved
content/livesync/quickstart.textile Outdated Show resolved Hide resolved
content/livesync/quickstart.textile Outdated Show resolved Hide resolved
content/livesync/quickstart.textile Outdated Show resolved Hide resolved
content/livesync/quickstart.textile Outdated Show resolved Hide resolved
content/livesync/quickstart.textile Outdated Show resolved Hide resolved
content/livesync/quickstart.textile Show resolved Hide resolved
content/livesync/quickstart.textile Outdated Show resolved Hide resolved
content/livesync/quickstart.textile Show resolved Hide resolved
@GregHolmes GregHolmes temporarily deployed to ably-docs-dtp-732-creat-izlioz June 7, 2024 11:44 Inactive
@GregHolmes GregHolmes temporarily deployed to ably-docs-dtp-732-creat-izlioz June 7, 2024 11:46 Inactive
@GregHolmes GregHolmes temporarily deployed to ably-docs-dtp-732-creat-izlioz June 7, 2024 11:52 Inactive
@GregHolmes GregHolmes temporarily deployed to ably-docs-dtp-732-creat-izlioz June 7, 2024 11:54 Inactive
@GregHolmes GregHolmes temporarily deployed to ably-docs-dtp-732-creat-izlioz June 7, 2024 11:58 Inactive
@GregHolmes GregHolmes temporarily deployed to ably-docs-dtp-732-creat-izlioz June 7, 2024 12:03 Inactive
@GregHolmes GregHolmes requested a review from Srushtika June 7, 2024 12:47
Copy link
Member

@Srushtika Srushtika left a comment

Choose a reason for hiding this comment

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

Thanks for the changes @GregHolmes , added a few minor comments, hopefully the last round.

content/livesync/quickstart.textile Show resolved Hide resolved
content/livesync/quickstart.textile Outdated Show resolved Hide resolved
content/livesync/quickstart.textile Outdated Show resolved Hide resolved
content/livesync/quickstart.textile Outdated Show resolved Hide resolved
content/livesync/quickstart.textile Outdated Show resolved Hide resolved
@GregHolmes GregHolmes temporarily deployed to ably-docs-dtp-732-creat-izlioz June 10, 2024 15:22 Inactive
Copy link
Member

@Srushtika Srushtika left a comment

Choose a reason for hiding this comment

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

Nice work, thanks @GregHolmes

author Greg Holmes <greg.holmes@ably.com> 1715178687 +0100
committer Greg Holmes <greg.holmes@ably.com> 1717598982 +0100

Add Quickstart page content
@GregHolmes GregHolmes force-pushed the DTP-732-Create-Quickstart-page branch from 86e30f1 to 0bfea92 Compare June 10, 2024 15:31
@GregHolmes GregHolmes temporarily deployed to ably-docs-dtp-732-creat-izlioz June 10, 2024 15:31 Inactive
@GregHolmes GregHolmes merged commit bf74596 into main Jun 10, 2024
4 checks passed
@GregHolmes GregHolmes deleted the DTP-732-Create-Quickstart-page branch June 10, 2024 15:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants