review commit

mous13 · mous13 · commit c5a3b19e6d65 · 2025-08-03T21:57:05.000+01:00
diff --git a/public/user-manual/plugins/perscom-plugin/awarduser.jpg b/public/user-manual/plugins/perscom-plugin/awarduser.jpg
diff --git a/public/user-manual/plugins/perscom-plugin/sync.jpg b/public/user-manual/plugins/perscom-plugin/sync.jpg
diff --git a/public/user-manual/plugins/perscom-plugin/sync_log.jpg b/public/user-manual/plugins/perscom-plugin/sync_log.jpg
diff --git a/src/app/plugins/perscom-plugin/assignments/page.mdx b/src/app/plugins/perscom-plugin/assignments/page.mdx
@@ -1,6 +1,8 @@
 import GuideNavigator from '@/components/GuideNavigator';
 
-# How to create an assignment record
+# Assignments
+
+## How to create an assignment record
 
 To create an assignment record, go to your perscom users (Admin Panel > PERSCOM > Users) and click on the Quick Actions button and select new Assignment.
 
diff --git a/src/app/plugins/perscom-plugin/awards/page.mdx b/src/app/plugins/perscom-plugin/awards/page.mdx
@@ -1,29 +1,27 @@
 import GuideNavigator from '@/components/GuideNavigator';
 import Alert from '@/components/Alert';
 
-# How to create an award
+# Awards
 Awards are a way to recognize exceptional service, achievements which can incentivize participation and boost morale.
 
+
+## How to create an award
+To create an award, go to Admin Panel > PERSCOM > Organization > Awards and click on the + button.
 ![Awards](/user-manual/plugins/perscom-plugin/award.jpg)
 - **Name**: The name of the award.
 - **Description**: Brief summary outlining the award, could include the requirements for it.
 - **Image**: Visual ribbon or medal representing the award, displayed on p-files.
 
-# How to award users
+## How to award users
 To award users, go to your perscom users (Admin Panel > PERSCOM > Users) and click on the Quick Actions button and select New Award.
 
-![promotion](/user-manual/plugins/perscom-plugin/promotion.jpg)
+![AwardUser](/user-manual/plugins/perscom-plugin/awarduser.jpg)
 - **Users**: Here you can select an individual user or multiple.
 - **Created At**: Date of record.
-- **Type**: Whether it's a demotion or promotion.
-- **Rank**: The user's new rank.
+- **Rank**: The award you'd like to award.
 - **Text**: If you want to supply a custom message which is displayed on the p-file.
 - **Document**: Attach a document to the record.
 
-<Alert severity="info">
-    For demotions, follow the exact same steps, except select the type "Demote"
-</Alert>
-
 <GuideNavigator
     previous={{ href: '/plugins/perscom-plugin/promotions', label: 'Promotions' }}
     next={{ href: '/plugins/perscom-plugin/qualifications', label: 'Qualifications' }}
diff --git a/src/app/plugins/perscom-plugin/combat/page.mdx b/src/app/plugins/perscom-plugin/combat/page.mdx
@@ -1,7 +1,9 @@
 import GuideNavigator from '@/components/GuideNavigator';
 
-# How to create a combat record
+# Combat Records
 Combat Records are a great way to track user's attendance to missions, trainings, and meetings.
+
+## How to create a combat record
 To create a combat record, go to your perscom users (Admin Panel > PERSCOM > Users) and click on the Quick Actions button and select New Combat Record.
 
 ![Combat](/user-manual/plugins/perscom-plugin/combat.jpg)
@@ -12,4 +14,5 @@ To create a combat record, go to your perscom users (Admin Panel > PERSCOM > Use
 
 <GuideNavigator
     previous={{ href: '/plugins/perscom-plugin/qualifications', label: 'Qualifications' }}
+    next={{ href: '/plugins/perscom-plugin/sync', label: 'Sync' }}
 />
diff --git a/src/app/plugins/perscom-plugin/enlistment/page.mdx b/src/app/plugins/perscom-plugin/enlistment/page.mdx
@@ -1,12 +1,11 @@
 import GuideNavigator from '@/components/GuideNavigator';
 import Alert from '@/components/Alert';
 
-# Enlistment Setup
+# Enlistment
 
-Users that sign up to your website should not need access to PERSCOM.io, so the entire enlistment process is encapsulated within forumify.
+## Enlistment Setup
 
-
-To set up Enlistments, head over to the admin control panel > PERSCOM > Configuration
+To set up Enlistments, head over to the Admin Panel > PERSCOM > Configuration
 ![Enlistment Setup](/user-manual/plugins/perscom-plugin/enlistment.jpg)
 
 On this page you can modify the plugin's behaviour when it comes to enlistments and if it should automatically post the enlistment in a forum
@@ -19,7 +18,7 @@ you'll need to head over to your PERSCOM.io > Forms > Edit "Form Name" and click
 When a user creates an enlistment, a submission will be made (Admin Panel > PERSCOM > Submissions > "Your Enlistment Form Name").
 From there the enlistment can be accepted or denied.
 
-# Enlistment Flow
+## Enlistment Flow
 The enlistment flow is a breakdown of the enlistment process for admins to understand.
 
 1) When a forumify user submits an enlistment application through the PERSCOM > Enlist menu, a PERSCOM user is automatically created.
diff --git a/src/app/plugins/perscom-plugin/introduction/page.mdx b/src/app/plugins/perscom-plugin/introduction/page.mdx
@@ -15,8 +15,6 @@ Seamlessly integrate PERSCOM.io into your forumify instance.
 
 Package name for manual installation: `forumify/forumify-perscom-plugin`
 
-<Alert severity="warning">The PERSCOM.io plugin requires you to have PERSCOM.io PRO license or higher for API access.</Alert>
-
 ## Settings
 
 After installing and activating the plugin, open the plugin settings by clicking the "Manage" dropdown and selecting "Settings".
@@ -33,18 +31,6 @@ Save the configuration. You can check if your installation was done correctly by
     If you're using an old key, we recommend creating a new one as PERSCOM.io updated their api so the perscom ID is now part of the API key.
 </Alert>
 
-## Users
-
-The forumify plugin will attempt to link existing users on PERSCOM.io to your forumify users by matching their email addresses.
-If a user uses a different email on forumify, you will have to modify their email on PERSCOM.io to match their forumify email.
-
-All types of records can be created from within forumify. So your day-to-day actions can all be managed from within the forumify admin panel.
-
-<Alert severity="warning">
-    While generally your personnel will not require the use of PERSCOM.io, their user must exist on PERSCOM.io as it will be used for auditing on PERSCOM.io's side.
-    They do not require any special permissions on PERSCOM.io, the forumify plugin does not respect any PERSCOM.io permissions.
-</Alert>
-
 # Invision Community Migrator
 
 In an effort to save time when moving from Invision Community's PERSCOM plugin to PERSCOM.io in combination with forumify a small
diff --git a/src/app/plugins/perscom-plugin/promotions/page.mdx b/src/app/plugins/perscom-plugin/promotions/page.mdx
@@ -1,7 +1,9 @@
 import GuideNavigator from '@/components/GuideNavigator';
 import Alert from '@/components/Alert';
 
-# How to promote users
+# Promotions
+
+## How to promote users
 
 To promote users, go to your perscom users (Admin Panel > PERSCOM > Users) and click on the Quick Actions button and select Promote/Demote.
 
diff --git a/src/app/plugins/perscom-plugin/qualifications/page.mdx b/src/app/plugins/perscom-plugin/qualifications/page.mdx
@@ -1,6 +1,8 @@
 import GuideNavigator from '@/components/GuideNavigator';
 
-# How to create a qualification
+# Qualifications
+
+## How to create a qualification
 Qualifications are a way for users to qualify on courses, enhancing their skills within the unit.
 
 ![Qualifications](/user-manual/plugins/perscom-plugin/qualification.jpg)
@@ -11,7 +13,7 @@ Qualifications are a way for users to qualify on courses, enhancing their skills
 See below for example of qualification insignia displayed on p-file records.
 ![Qualifications](/user-manual/plugins/perscom-plugin/qualification_display.jpg)
 
-# How to assign a qualification to a user
+## How to assign a qualification to a user
 To qualify users, go to your perscom users (Admin Panel > PERSCOM > Users) and click on the Quick Actions button and select New Qualification.
 
 ![promotion](/user-manual/plugins/perscom-plugin/promotion.jpg)
diff --git a/src/app/plugins/perscom-plugin/sync/page.mdx b/src/app/plugins/perscom-plugin/sync/page.mdx
@@ -0,0 +1,24 @@
+import GuideNavigator from '@/components/GuideNavigator';
+import Alert from '@/components/Alert';
+
+# Sync
+To keep data up to date, the perscom integration plugin uses 2 way data synchronization. When you edit an item within the plugin, it will automatically be sent to
+PERSCOM.io. All changes from PERSCOM.io are also replicated daily to the plugin.
+
+## Manual Synchronization
+
+If you can not wait until the next automatic sync, you can use the Trigger Manual Sync button in the top right corner of the sync page (Admin Panel > PERSCOM > Sync).
+<Alert severity="info">
+    Clicking Trigger Manual Sync button will launch a two-step confirmation. You'll be taken to a confirmation screen that'll warn you about the full data sync impact and only after you've
+    clicked continue is the sync actually processed. This is an extra step that acts as a failsafe in case the button is pressed accidentally.
+</Alert>
+
+![Sync](/user-manual/plugins/perscom-plugin/sync.jpg)
+
+You can see the history of both manual and automatic syncs as well as a log for each.
+
+![Sync](/user-manual/plugins/perscom-plugin/sync_log.jpg)
+
+<GuideNavigator
+    previous={{ href: '/plugins/perscom-plugin/qualifications', label: 'Qualifications' }}
+/>
