Create Managing an Organization's Glific Account: Suspension and Dele… #304
Conversation
…tion.md Added detailed steps involved in suspension & deletion
WalkthroughThis pull request adds a new documentation page titled "Managing an Organization's Glific Account: Suspension and Deletion". The guide explains the procedures and implications for two modes of account management. Suspension Mode preserves the organization’s current flows and data access via BigQuery, while imposing a monthly maintenance charge and allowing account reactivation upon dues clearance. In contrast, Deletion Mode permanently removes the account and all associated flows, following a similar advance notice requirement. The document also outlines the necessary steps to notify the Glific Support Team and schedule related actions. Changes
Sequence Diagram(s)sequenceDiagram
participant Org as Organization
participant Sup as Glific Support
participant Sys as Platform System
participant BQ as BigQuery
Org->>Sup: Submit suspension request (15-day notice)
Sup-->>Org: Confirm maintenance details & schedule action
Org->>Sys: Initiate Suspension Mode
Sys->>BQ: Ensure data remains accessible
Sys->>Org: Restrict platform access
Org->>Sup: Request reactivation (after clearing dues)
Sup-->>Sys: Process reactivation request
sequenceDiagram
participant Org as Organization
participant Sup as Glific Support
participant Sys as Platform System
Org->>Sup: Submit deletion request (15-day notice)
Sup-->>Org: Schedule call & verify dues clearance
Org->>Sup: Confirm backup and call schedule
Sup->>Sys: Initiate permanent deletion
Sys-->>Org: Permanently remove account and flows
Poem
Warning There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure. 🔧 Gitleaks (8.21.2)docs/2. Onboarding/Managing an Organization's Glific Account: Suspension and Deletion.md/bin/bash: -c: line 1: unexpected EOF while looking for matching `'' 🔧 markdownlint-cli2 (0.17.2)docs/2. Onboarding/Managing an Organization's Glific Account: Suspension and Deletion.md/bin/bash: -c: line 1: unexpected EOF while looking for matching `'' 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
|
🚀 Deployed on https://deploy-preview-304--glific-docs.netlify.app |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (5)
docs/2. Onboarding/Managing an Organization's Glific Account: Suspension and Deletion.md (5)
1-2: Header Formatting and Readability
The "5 minute read" header uses extensive inline HTML non-breaking spaces which may reduce maintainability. Consider simplifying the spacing (or using CSS classes) to achieve the desired visual layout.
31-31: Improve Instructional Clarity and Correct Typos in Suspension Request
The instruction on line 31 contains "atleast 15 days prior to" which has both a typo and slightly verbose phrasing. Consider updating it to "at least 15 days before" to improve clarity and correctness.-1) Notify the Glific Support Team on email [email protected] or raise a Support Ticket on [Discord Ngo support channel](https://discord.gg/gYHMRGQVpT) atleast 15 days prior to the desired suspension date. +1) Notify the Glific Support Team via email (mailto:[email protected]) or raise a Support Ticket on [Discord Ngo support channel](https://discord.gg/gYHMRGQVpT) at least 15 days before the desired suspension date.🧰 Tools
🪛 LanguageTool
[style] ~31-~31: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: .../discord.gg/gYHMRGQVpT) atleast 15 days prior to the desired suspension date. 2) If th...(EN_WORDINESS_PREMIUM_PRIOR_TO)
50-50: Consistent Terminology for Account Deletion
The deletion section uses "Organisation" while other parts of the document use "organization". Consider standardizing the terminology for consistency.-1) The Organisation account and all associated flows will be permanently deleted. +1) The Organization account and all associated flows will be permanently deleted.🧰 Tools
🪛 LanguageTool
[uncategorized] ~50-~50: Do not mix variants of the same word (‘organisation’ and ‘organization’) within a single text.
Context: ...What happens in Deletion Mode ? 1) The Organisation account and all associated flows will b...(EN_WORD_COHERENCY)
58-58: Enhance Deletion Request Instructions
Similar to the suspension instructions, the deletion process text has "atleast 15 days prior to". Updating this to "at least 15 days before" will correct the typo and reduce verbosity. Also consider converting the plain email text to a mailto hyperlink (see next comment).-1) Drop an email to the Glific Support team on [email protected] or raise a ticket on [Discord Ngo support channel](https://discord.gg/gYHMRGQVpT) atleast 15 days prior to the desired deletion date. +1) Drop an email to the Glific Support team via (mailto:[email protected]) or raise a ticket on [Discord Ngo support channel](https://discord.gg/gYHMRGQVpT) at least 15 days before the desired deletion date.🧰 Tools
🪛 LanguageTool
[style] ~58-~58: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: .../discord.gg/gYHMRGQVpT) atleast 15 days prior to the desired deletion date. 2) The Gli...(EN_WORDINESS_PREMIUM_PRIOR_TO)
76-77: Improve Link Usability for Support Contacts
The email link in the "Important" note is currently plain text. Converting it to a mailto link (e.g.[Email](mailto:[email protected])) can enhance usability by allowing users to open their default email client directly.-**Important:** [Email]([email protected]) or [Discord](https://discord.gg/gYHMRGQVpT) intimation for account suspension and deletion must also be provided to the **Glific Support Team** at least **15** days in advance. +**Important:** [Email](mailto:[email protected]) or [Discord](https://discord.gg/gYHMRGQVpT) intimation for account suspension and deletion must also be provided to the **Glific Support Team** at least **15** days in advance.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/2. Onboarding/Managing an Organization's Glific Account: Suspension and Deletion.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/2. Onboarding/Managing an Organization's Glific Account: Suspension and Deletion.md
[style] ~31-~31: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: .../discord.gg/gYHMRGQVpT) atleast 15 days prior to the desired suspension date. 2) If th...
(EN_WORDINESS_PREMIUM_PRIOR_TO)
[uncategorized] ~50-~50: Do not mix variants of the same word (‘organisation’ and ‘organization’) within a single text.
Context: ...What happens in Deletion Mode ? 1) The Organisation account and all associated flows will b...
(EN_WORD_COHERENCY)
[style] ~58-~58: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: .../discord.gg/gYHMRGQVpT) atleast 15 days prior to the desired deletion date. 2) The Gli...
(EN_WORDINESS_PREMIUM_PRIOR_TO)
🔇 Additional comments (2)
docs/2. Onboarding/Managing an Organization's Glific Account: Suspension and Deletion.md (2)
3-8: Document Title and Introduction Clarity
The title and introductory lines clearly state the document’s purpose. They give a straightforward overview of the processes related to account suspension and deletion. Ensure consistency with similar documentation pages in formatting and tone.
9-17: Suspension Mode Section Overview
The "Suspension Mode" section succinctly explains the implications, including data preservation and restricted access. It successfully informs users about maintenance charges and flow retention. Just double-check the punctuation in the subheading (extra space before the question mark) if your style guide requires tightening.
Added detailed steps involved in suspension & deletion
Summary by CodeRabbit