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

Add module responsibilities and critical path to README #11

Merged
merged 2 commits into from
Apr 8, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,18 @@
# WordPress Plugin Deactivation Module
A module for handling WordPress brand plugins and modules deactivations.

## Module Responsibilities

- Display a modal/popup when a user attemps to deactivate the brand plugin on plugins.php page.
- The modal contains two steps. The first one, will bring the user's attention to all the features that brand plugin adds to their site. And the second step is a survey form asking the user for the reason they're deactivating the plugin.
- When the survey is submitted, the response is captured for analytics.
- When the brand plugin is deactivated, the moduel will set the coming soon option in the database.
wpalani marked this conversation as resolved.
Show resolved Hide resolved

## Critical Paths

- On plugins.php page when the user clicks `Deactivate` on the brand plugin, the survey modal should appear.
- In the modal, when the modal clicks `Skip and Deactivate` or `Submit` the modal MUST be closed and the plugin MUST be deactivated.

## Installation

### 1. Add the Newfold Satis to your `composer.json`.
Expand Down
Loading