Skip to content

EDU-1838-Adds self-serve account closure copy #2537

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

franrob-projects
Copy link
Contributor

This PR:

  • Adds copy for self-serve account closure feature.

https://ably.atlassian.net/browse/EDU-1838

Copy link

coderabbitai bot commented Apr 16, 2025

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@ably-ci ably-ci temporarily deployed to ably-docs-edu-1838-clos-ew7iyk April 16, 2025 08:44 Inactive
@franrob-projects franrob-projects temporarily deployed to ably-docs-edu-1838-clos-ew7iyk April 16, 2025 08:56 Inactive
@franrob-projects franrob-projects force-pushed the EDU-1838-Close-ably-account branch from bd2cc84 to 2c547b0 Compare April 16, 2025 08:57
@franrob-projects franrob-projects temporarily deployed to ably-docs-edu-1838-clos-ew7iyk April 16, 2025 08:57 Inactive
@franrob-projects franrob-projects temporarily deployed to ably-docs-edu-1838-clos-ew7iyk April 17, 2025 14:31 Inactive
@franrob-projects franrob-projects force-pushed the EDU-1838-Close-ably-account branch from 43c95e1 to e32b418 Compare April 17, 2025 14:32
@franrob-projects franrob-projects temporarily deployed to ably-docs-edu-1838-clos-ew7iyk April 17, 2025 14:32 Inactive
@franrob-projects franrob-projects marked this pull request as ready for review April 17, 2025 14:33
@matt423 matt423 temporarily deployed to ably-docs-edu-1838-clos-tjjz3w April 23, 2025 08:37 Inactive
You can cancel your account at any time by downgrading to the "Free package":/docs/pricing/free. The following steps outline the the process to cancel your account:

* Ensure you are the account "owner":/docs/account/users#roles.
* Downgrade all paid "packages":/docs/pricing#packages free packages:
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
* Downgrade all paid "packages":/docs/pricing#packages free packages:
* Downgrade all paid "packages":/docs/pricing#packages to Free:

@@ -74,4 +74,27 @@ To remove a user from your account:

h2(#delete). Delete your account
Copy link
Contributor

Choose a reason for hiding this comment

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

Title and anchor are still for 'delete'.

Comment on lines +84 to +87
** Navigate to *Want to delete your profile?*.
** Click *start* to begin the closure process.
* On the *Close Your Ably Account* page:
Copy link
Contributor

Choose a reason for hiding this comment

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

We should raise a PR to make the naming in the dashboard consistent and for this to match ideally.

You can cancel your account at any time by downgrading to the "Free package":/docs/pricing/free. The following steps outline the the process to cancel your account:

* Ensure you are the account "owner":/docs/account/users#roles.
* Downgrade all paid "packages":/docs/pricing#packages free packages:
Copy link
Contributor

Choose a reason for hiding this comment

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

This is referring to multiple packages throughout the steps, but presumably this happens on an account-by-account basis and should be singular?

** Confirm all accounts are on the *Free* tier and details are accurate.
** Click *Confirm Closure* to permanently deactivate your Ably account.

If you sign in with SSO, for example, Google or GitHub, you cannot use the self-service account closure process. To proceed, you must set a password and disconnect their SSO provider via My Settings.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
If you sign in with SSO, for example, Google or GitHub, you cannot use the self-service account closure process. To proceed, you must set a password and disconnect their SSO provider via My Settings.
If you sign in with SSO, for example, Google or GitHub, you cannot use the self-service account closure process. To proceed, you must set a password and disconnect your SSO provider via My Settings.

Link to 'My Settings'?


* Ensure you are the account "owner":/docs/account/users#roles.
* Downgrade all paid "packages":/docs/pricing#packages free packages:
** Navigate to *Account* then *Billing*.
Copy link
Contributor

Choose a reason for hiding this comment

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

Can we link directly to the billing page here?

* In the *Password* section, click *Change your password*.
* Click *Update my personal settings* to save the changes.
* Scroll to the *Login provider* section.
* Click *remove connection* next to the SSO provider/s you want to disconnect.
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm assuming after you do these steps, you can then close your account as per above? If that's the case, we need a final bullet point here to note that, and also to update the paragraph that states 'you cannot use the self-service account closure'.

Comment on lines 166 to 185
* Ensure you are the account "owner":/docs/account/users#roles.
* Downgrade all paid "packages":/docs/pricing#packages free packages:
** Navigate to *Account* then *Billing*.
** Click *Save billing details* to save your changes.
* After all packages have been downgraded to *Free*, go to the *My Settings* page.
** Navigate to *Want to delete your profile?*.
** Click *start* to begin the closure process.
* On the *Close Your Ably Account* page:
** Review the account summary, including ownership, plan type, and app details.
** Confirm all accounts are on the *Free* tier and details are accurate.
** Click *Confirm Closure* to permanently deactivate your Ably account.

If you sign in with SSO, for example, Google or GitHub, you cannot use the self-service account closure process. To proceed, you must set a password and disconnect their SSO provider via My Settings.

* Log in to your Ably account using your current SSO method (Google or GitHub).
* Navigate to *Account* then *My Settings*.
* In the *Password* section, click *Change your password*.
* Click *Update my personal settings* to save the changes.
* Scroll to the *Login provider* section.
* Click *remove connection* next to the SSO provider/s you want to disconnect.
Copy link
Contributor

Choose a reason for hiding this comment

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

I'd link out to the section you've written above rather than repeating all these steps in the FAQ.

Comment on lines 68 to 91
* Ensure you are the account "owner":/docs/account/users#roles.
* Downgrade all paid "packages":/docs/pricing#packages free packages:
** Navigate to *Account* then *Billing*.
** Click *Save billing details* to save your changes.
* After all packages have been downgraded to *Free*, go to the *My Settings* page.
** Navigate to *Want to delete your profile?*.
** Click *start* to begin the closure process.
* On the *Close Your Ably Account* page:
** Review the account summary, including ownership, plan type, and app details.
** Confirm all accounts are on the *Free* tier and details are accurate.
** Click *Confirm Closure* to permanently deactivate your Ably account.

If you sign in with SSO, for example, Google or GitHub, you cannot use the self-service account closure process. To proceed, you must set a password and disconnect their SSO provider via My Settings.

* Log in to your Ably account using your current SSO method (Google or GitHub).
* Navigate to *Account* then *My Settings*.
* In the *Password* section, click *Change your password*.
* Click *Update my personal settings* to save the changes.
* Scroll to the *Login provider* section.
* Click *remove connection* next to the SSO provider/s you want to disconnect.

<aside data-type='note'>
<p>Closing your account will permanently delete all associated data and cannot be undone.</p>
</aside>
Copy link
Contributor

Choose a reason for hiding this comment

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

I'd suggest the same as per above about not repeating all of this info on each page. My reasoning for this is that it's quite a large number of steps compared to the upgrade/downgrade process.


h2(#close). Close your account

You can close your account at any time by first "downgrading":#downgrade to the "Free package":/docs/pricing/free. The following steps outline the the process to close your account:
Copy link
Contributor

Choose a reason for hiding this comment

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

This is the Free package page, so should be worded a little differently and not link to itself.

@franrob-projects franrob-projects force-pushed the EDU-1838-Close-ably-account branch from ff1cb71 to a34e124 Compare April 29, 2025 12:47
@franrob-projects franrob-projects temporarily deployed to ably-docs-edu-1838-clos-9xvit0 April 29, 2025 13:39 Inactive
@franrob-projects franrob-projects temporarily deployed to ably-docs-edu-1838-clos-9xvit0 April 29, 2025 14:47 Inactive
@franrob-projects franrob-projects force-pushed the EDU-1838-Close-ably-account branch from c3858d0 to 8c357a1 Compare April 29, 2025 14:48
@franrob-projects franrob-projects temporarily deployed to ably-docs-edu-1838-clos-9xvit0 April 29, 2025 14:48 Inactive
Comment on lines +84 to +86
* After your account has been downgraded to *Free*, go to the "My Settings":https://ably.com/users/edit page.
** Navigate to *Want to delete your profile?*.
** Click *start* to begin the closure process.
Copy link
Member

Choose a reason for hiding this comment

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

The closure process will only be available on the next billing cycle(first of the month) as we ensure that the account has no outstanding invoices

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done 👉 ff291a8

Follow "this process":https://faqs.ably.com/how-do-i-cancel-my-account to delete your Ably account. Only an account owner can initiate this process.
h2(#close). Close your account

You can close your account at any time by downgrading to the "Free package":/docs/pricing/free. The following steps cancel your account:
Copy link
Member

Choose a reason for hiding this comment

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

[notes] Not sure if we should be more explicit that, this is closing the user's Ably account, such that they won't be able to login after this process. There might be some confusion that this is just closing a specific account within their Ably user account.

Also, it might be worth noting that, the user will also be removed from any associated accounts, i.e if they're an account user an another account, they will be removed.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done 👉 ff291a8

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.

4 participants