Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
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
Binary file added assets/Module-guest-view.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/Module-logged-view.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/Module_configuration.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/Module_installation.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/Module_management.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 4 additions & 3 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,17 +17,18 @@
},
"autoload": {
"psr-4": {
"Binary\\Component\\CmsMigrator\\": "src/component/admin/src/"
"Joomla\\Component\\CmsMigrator\\Administrator\\": "src/component/admin/src/"
}
},
"require-dev": {
"phpunit/phpunit": "^10",
"joomla/test": "^2",
"mockery/mockery": "^1.6"
"mockery/mockery": "^1.6",
"squizlabs/php_codesniffer": "*"
},
"autoload-dev": {
"psr-4": {
"Binary\\Component\\CmsMigrator\\Tests\\": "tests/"
"Joomla\\Component\\CmsMigrator\\Tests\\": "tests/unit/"
}
},
"scripts": {
Expand Down
74 changes: 74 additions & 0 deletions docs/Migration_Notice_Guide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
# Migration Notice Module - User Manual

The Migration Notice Module helps to explain password reset requirements to end users after migrating from Source into Joomla. It displays clear instructions and reduces login issues.

---

## 🚀 Installation

### Step 1: Install the Module

#### The Module is by default installed with the com_cmsmigrator component. If you need to install it separately, follow these steps:

1. **Login** to Joomla Administrator
2. **Go to** Extensions → Manage → Install
3. **Upload** the ZIP file (`mod_migrationnotice_v1.0.0.zip`)
4. **Click** Install

![Installation Process](../assets/Module_installation.png)

✅ **Success**: Language overrides are automatically created for login error messages.

---

## ⚙️ Configuration

### Step 2: Set Up the Module
1. **Go to** Extensions → Modules
2. **Click** "New" → Select "Migration Notice Module"
3. **Configure** these key settings:

![Module Configuration](../assets/Module_configuration.png)

| Setting | Recommended Value |
|---------|------------------|
| **Show Migration Notice** | Yes |
| **Notice Type** | Both |
| **Alert Style** | Warning |
| **Show Password Reset Link** | Yes |
| **Menu Assignment** | All Pages |
| **Position** | Top |

4. **Save & Close**

---

## 👀 What Users See

### Guest Users (Not Logged In)
![Guest User View](../assets/Module-guest-view.png)

Shows:
- Migration explanation
- Password reset requirement
- Login button

### Logged-In Users
![Logged User View](../assets/Module-logged-view.png)

Shows:
- Password reset notice
- Direct "Reset Password" button

## 🔧 Management

### Editing the Module
**Extensions** → **Modules** → **Find your module** → **Click title to edit**

![Module Management](../assets/Module_management.png)

### Common Tasks
- **Hide temporarily**: Set "Show Migration Notice" to No
- **Change message**: Use "Custom Message" field
- **Different pages**: Adjust "Menu Assignment"
- **New position**: Change "Position" setting
Loading
Loading