Skip to content

Commit 182ffe4

Browse files
committed
update the docs
1 parent 7bfa3d1 commit 182ffe4

File tree

9 files changed

+37
-19
lines changed

9 files changed

+37
-19
lines changed

docs/DEVELOPER_GUIDE.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
## 📋 Overview
44

55
This guide provides technical details for developers working on the Content Creation Management (CCM) component. The CCM component enables seamless content migration between different Content Management Systems (CMS) using a Common Content Model (CCM) and Model-Driven Engineering (MDE) format.
6+
revise this
67

78
## 💻 Environment
89

@@ -88,8 +89,8 @@ env: {
8889
2. Map content types between a CMS and the CCM:
8990
- **Posts/Articles**: Map WordPress "posts" or Joomla "articles" to the CCM "ContentItem" type.
9091
- **Categories**: Align CMS-specific categories/taxonomies to the CCM "categories" property.
91-
- **Users/Authors**: Map user or author fields to the CCM "author" definition. *(future work)*
92-
- **Media**: Link media files (images, attachments) to the CCM "media" references. *(future work)*
92+
- **Users/Authors**: Map user or author fields to the CCM "author" definition.
93+
- **Media**: Link media files (images, attachments) to the CCM "media" references.
9394
- **Custom Fields**: Extend the mapping for any custom fields or metadata your CMS uses. *(future work)*
9495

9596
### Example Mapping File

docs/USER_GUIDE.md

Lines changed: 34 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ The Content Creation Management (CCM) component is a Joomla extension that enabl
2222

2323
### Joomla Installation
2424

25-
1. Open your Joomla app
25+
1. Open your Joomla app *(Preferably a new instance)*
2626
2. Access the administrator panel
2727
3. Navigate to **System > Install > Extensions**
2828
4. Upload the zip file for the component
@@ -37,25 +37,32 @@ The component will automatically create the required database tables upon instal
3737

3838
### 1. Editing a CMS
3939

40-
1. In Joomla Admin, go to **Components > CCM**
40+
1. In Joomla Admin, go to **Components > CMSs > CMS Management**
4141
2. Choose one of the CMSs
4242
3. Update the CMS details:
4343
- **Name**: Descriptive name for the CMS
4444
- **URL**: Base URL of the source CMS
45-
- **Credentials**: API keys or authentication details. Refer to [Auth Guidance](AUTHENTICATION_GUIDE.md).
45+
- **Credentials**: API keys or authentication details. Refer to [Auth Guidance](AUTHENTICATION_GUIDE.md) for developer details.
4646

47-
### 2. Obtaining CMS Credentials
47+
### 2. Obtaining CMS Credentials & Adding them in Joomla CMS
4848

4949
Before you can migrate content, you need to obtain the proper API credentials for each CMS:
5050

5151
#### For WordPress
5252

53-
**Generate Application Password** (Paid plans only):
53+
**Generate Application Password**:
5454
- Go to **My Sites → Settings → Security**
5555
- Scroll down to **Application Passwords**
5656
- Click **Create New Application Password**
57-
- Enter name: "CMS Migration" *or name*
57+
- Enter name: "CMS Migration" *or any preferred name*
5858
- Copy the generated password
59+
- In CMS Management, choose "WordPress"
60+
![CMSs Page image](images/cmss.png)
61+
- We need a base64 generator (e.g., [Base64 Encode](https://www.debugbear.com/basic-auth-header-generator))
62+
put your WordPress username and password, then take the generated authentication (e.g. Authorization: Basic UmVlbTpQYXNzd29yZA==)
63+
![WordPress CMS Auth image](images/wordpress%20auth.png)
64+
- Add them in the WordPress auth
65+
![WordPress CMS Page image](images/wordpress%20cms.png)
5966

6067
#### For Joomla
6168
1. **Create API Token**:
@@ -65,23 +72,19 @@ Before you can migrate content, you need to obtain the proper API credentials fo
6572
- Select appropriate **User** (should have necessary permissions)
6673
- Click **Save**
6774
- Copy the generated token
75+
- In CMS Management, choose "Joomla"
76+
- Add the generated token with 'Bearer' before it.
77+
![Joomla CMS Page image](images/joomla%20cms.png)
6878

6979
> **Security Note**: Always use dedicated API credentials with minimal required permissions. Never use your main administrator password for API access.
7080
7181
### 3. Running a Migration
7282

73-
1. Navigate to **Components > CCM > Migration**
83+
1. Navigate to **Components > CMSs > Migration**
7484
2. Select source and target CMS
75-
3. Choose content types to migrate:
76-
- Categories
77-
- Articles/Posts
78-
- Media files
79-
- Users *(future work)*
80-
81-
> **Note:** It is important to migrate the referenced items first. For example, we need to migrate **categories first**, as articles/posts reference categories. Migrating articles before their referenced categories exist may result in missing or incorrect category assignments. Always follow this order: **Categories → Media files → Users → Articles/Posts**.
82-
83-
4. Click **Apply Migration**
84-
5. Monitor progress in real-time
85+
3. Click **Apply Migration**
86+
4. At the end, monitor the success migration and the failed ones (if any).
87+
![success migration image](images/success%20migration.png)
8588

8689
### 4. Migration Process
8790

@@ -91,3 +94,17 @@ The migration follows these steps:
9194
2. **CCM Conversion**: Transforms content to CCM standard format
9295
3. **Target Conversion**: Adapts CCM format to target CMS structure
9396
4. **Import**: Creates content in target CMS
97+
98+
### 5. Limitations & Adjustments for the cusrrent WordPress > Joomla
99+
- WordPress can have multiple categories, while Joomla uses a single category per article. So the migration process migrates only the first category attached with the post in WordPress.
100+
- WordPress has comments while Joomla doesn't, so they aren't migrated.
101+
- WordPress has Posts and Articles, both are migrated to Articles in Joomla.
102+
- Duplicate entries can cause failure to all migrations. Prefer to apply the migration in a new Joomla website.
103+
![Partial Migration Failure image](images/partial%20failure%20migration.png)
104+
- Media are migrated in "files" folder. The migration process creates "migration" folder and another folder is createds inside it with the name of the source CMS. Each time the migration is applied, a folder with the date now is created with all the media files.
105+
![media directories image](images/media.png)
106+
107+
### 6. What is migrated now
108+
109+
- **Content Types**: Categories, Tags, Media, Users, Articles, Menus, and Menu-Items
110+
- **Relationships**: Category and Tags associations, Media in the Articles text and User assignments

docs/images/cmss.png

92 KB
Loading

docs/images/joomla cms.png

101 KB
Loading

docs/images/media.png

225 KB
Loading
247 KB
Loading

docs/images/success migration.png

161 KB
Loading

docs/images/wordpress auth.png

153 KB
Loading

docs/images/wordpress cms.png

80.3 KB
Loading

0 commit comments

Comments
 (0)