Skip to content

Commit b4feb09

Browse files
committed
job user guide documentation on process
1 parent 9464f48 commit b4feb09

File tree

10 files changed

+114
-39
lines changed

10 files changed

+114
-39
lines changed

docs/.vitepress/config.ts

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -107,11 +107,13 @@ export default {
107107
items: [
108108
{ text: 'General', link: '/comfortjob/user-guide/general' },
109109
{ text: 'Job Manager', link: '/comfortjob/user-guide/job-manager' },
110-
{ text: 'Settings Manager', link: '/comfortjob/user-guide/settings-manager' },
110+
{ text: 'Settings Manager', link: '/comfortjob/user-guide/settings' },
111111
{ text: 'Company Manager', link: '/comfortjob/user-guide/company-manager' },
112-
{ text: 'Category Manager', link: '/comfortjob/user-guide/category-manager' },
113-
{ text: 'Category Manager', link: '/comfortjob/user-guide/category-manager' },
112+
{ text: 'Job Category', link: '/comfortjob/user-guide/job-category' },
113+
{ text: 'Job Type', link: '/comfortjob/user-guide/job-type' },
114+
{ text: 'Job Tags', link: '/comfortjob/user-guide/job-tags' },
114115
{ text: 'Tools Manager', link: '/comfortjob/user-guide/tools-manager' },
116+
{ text: 'Emails', link: '/comfortjob/user-guide/emails' },
115117
],
116118
}
117119
],

docs/comfortjob/user-guide/company-manager.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "Comfort Job Documentation"
33
description: "Comfort Job index description."
44
keywords: "Comfort Job index keywords."
5-
url: "/comfortjob/"
5+
url: "/comfortjob/user-guide/company-manager"
66
type: "type"
77
site_name: "Comfort HRM"
88
image: "https://comforthrm.com/assets/images/seo.png"
@@ -19,7 +19,14 @@ card: "article"
1919
## Adding Company Listings
2020

2121
1. Go to `Comfort Job > Add New Company`.
22-
2. Fill in the Company details such as title, description, website, email address, and phone number etc.
23-
3. Publish the Company.
22+
2. Fill in the company details. The required fields are:
23+
- **Company Name**: The name of the company.
24+
- **Company Description**: A detailed description of the company.
25+
3. Optional fields include:
26+
- **Company Website**: The company's website URL.
27+
- **Company Logo**: Upload the company's logo.
28+
- **Company Location**: The location of the company.
29+
- **Company Email**: The company's contact email address.
30+
- **Company Phone**: The company's contact phone number.
2431

2532

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
title: "Comfort Job Documentation"
3+
description: "Comfort Job index description."
4+
keywords: "Comfort Job index keywords."
5+
url: "/comfortjob/user-guide/emails"
6+
type: "type"
7+
site_name: "Comfort HRM"
8+
image: "https://comforthrm.com/assets/images/seo.png"
9+
card: "article"
10+
11+
---
12+
13+
## Email System
14+
15+
The Comfort Job plugin includes an email system to notify users about various events such as job application submissions, job approvals, and more.
16+
17+
#### Customizing Email Templates
18+
19+
1. Copy the desired email template file from `wp-content/plugins/comfortjobpro/templates/emails/` to your theme's directory, maintaining the folder structure.
20+
2. Edit the copied template file as needed.
21+
22+
#### Available Email Templates
23+
24+
- **New Job Application**: `guest_job_create_to_user.php`(Pro)
25+
- **Job Approved**: `guest_job_email_verified.php`(Pro)
26+
27+
### Single Email Settings
28+
29+
1. Go to `Comfort Job > Emails`.
30+
2. Configure the following email settings:
31+
32+
- **Subject**: The subject of the email.
33+
- **Email heading**: The heading of the email.
34+
- **Additional content**: The Additional content of the emails.
35+
- **From Name**: The name that will appear as the sender of the emails.
36+
- **From Email**: The email address that will appear as the sender of the emails.
37+
- **Admin Email**: The email address where admin notifications will be sent.
38+
- **CC/BCC**: The CC & BCC of the email.
39+
40+
3. Save changes.
41+

docs/comfortjob/user-guide/general.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "Comfort Job Documentation"
33
description: "Comfort Job index description."
44
keywords: "Comfort Job index keywords."
5-
url: "/comfortjob/"
5+
url: "/comfortjob/user-guide/general"
66
type: "type"
77
site_name: "Comfort HRM"
88
image: "https://comforthrm.com/assets/images/seo.png"

docs/comfortjob/user-guide/category-manager.md renamed to docs/comfortjob/user-guide/job-category.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "Comfort Job Documentation"
33
description: "Comfort Job index description."
44
keywords: "Comfort Job index keywords."
5-
url: "/comfortjob/user-guide/category-manager"
5+
url: "/comfortjob/user-guide/job-category"
66
type: "type"
77
site_name: "Comfort HRM"
88
image: "https://comforthrm.com/assets/images/seo.png"

docs/comfortjob/user-guide/job-manager.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "Comfort Job Documentation"
33
description: "Comfort Job index description."
44
keywords: "Comfort Job index keywords."
5-
url: "/comfortjob/"
5+
url: "/comfortjob/user-guide/job-manager"
66
type: "type"
77
site_name: "Comfort HRM"
88
image: "https://comforthrm.com/assets/images/seo.png"
@@ -19,6 +19,19 @@ card: "article"
1919
## Adding Job Listings
2020

2121
1. Go to `Comfort Job > Add New Job`.
22-
2. Fill in the job details such as title, description, location, company, and job type.
23-
3. Set the job expiration date if applicable.
22+
2. Fill in the job details. The required fields are:
23+
- **Job Title**: The title of the job.
24+
- **Job Description**: A detailed description of the job.
25+
- **Job Expiration Date**: Set the date when the job listing should expire.
26+
- **Company**: Select the company offering the job from the dropdown list.
27+
- **Job Status**: Select the status of the job.
28+
3. Optional fields include:
29+
- **Job Type**: Select the job type from the dropdown list (e.g., Full-Time, Part-Time).
30+
- **Job Category**: Select the job category from the dropdown list.
31+
- **Application Email/URL**: Provide an email address or URL where applications should be sent.
32+
- **Job Location**: The location where the job is based.
33+
- **Salary**: Provide the salary info for the job.
34+
- **Job Tags**: Add relevant tags for the job.
35+
- **Job Type**: Select Job type for the job.
36+
- **Job Seo**: Add relevant seo fields value for the job.
2437
4. Publish the job listing.
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
title: "Comfort Job Documentation"
3+
description: "Comfort Job index description."
4+
keywords: "Comfort Job index keywords."
5+
url: "/comfortjob/user-guide/job-tags"
6+
type: "type"
7+
site_name: "Comfort HRM"
8+
image: "https://comforthrm.com/assets/images/seo.png"
9+
card: "article"
10+
11+
---
12+
13+
### Job Categories
14+
15+
1. Go to `Comfort Job > Job Categories`.
16+
2. Add new job categories by filling in the name and description.
17+
3. Save changes.
18+
19+

docs/comfortjob/user-guide/job-type.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "Comfort Job Documentation"
33
description: "Comfort Job index description."
44
keywords: "Comfort Job index keywords."
5-
url: "/comfortjob/user-guide/category-manager"
5+
url: "/comfortjob/user-guide/job-type"
66
type: "type"
77
site_name: "Comfort HRM"
88
image: "https://comforthrm.com/assets/images/seo.png"
@@ -13,7 +13,7 @@ card: "article"
1313
### Job Types
1414

1515
1. Go to `Comfort Job > Job Types`.
16-
2. Add new job types by filling in the name and description.
16+
2. Add new job types by filling in the name and slug.
1717
3. Save changes.
1818

1919

docs/comfortjob/user-guide/settings-manager.md renamed to docs/comfortjob/user-guide/settings.md

Lines changed: 7 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "Comfort Job Documentation"
33
description: "Comfort Job index description."
44
keywords: "Comfort Job index keywords."
5-
url: "/comfortjob/"
5+
url: "/comfortjob/user-guide/settings"
66
type: "type"
77
site_name: "Comfort HRM"
88
image: "https://comforthrm.com/assets/images/seo.png"
@@ -17,7 +17,7 @@ card: "article"
1717
1. Go to `Comfort Job > Settings`.
1818
2. Configure the general settings such as job listing page, job submission page, and other options.
1919
3. Save changes.
20-
<!--
20+
2121
This short guide provides a basic walkthrough for setting up the Comfort Job plugin. For detailed instructions on each component, refer to the specific sections in the plugin documentation.
2222

2323
# General Settings Overview #
@@ -29,36 +29,20 @@ Navigate to **Comfort Job > Settings** in the WordPress admin dashboard. This se
2929
## Basic Settings ##
3030
These fundamental settings allow you to define core parameters for your accounting system. Some key options:
3131

32-
**Default Country:** Set the default country for all over the plugin.\
33-
**Default Currency:** Set the default currency for transactions.\
34-
**Number Settings**: Here we have option Number of Decimals, Decimal Separator, Thousand Separator, Currency Position.
35-
36-
Other options like **Show login form for guest user**, **Guest User Login Form**, **Show Register link to guest**, **Allow Edit Protected Logs**, **On Uninstall delete plugin data** are self introductory. Labels are there to guide.
32+
**Pages Slug** Set the slug country for different pages over the plugin.\
3733

38-
## Pages ##
39-
Select the page where you have placed the shortcodes.
40-
41-
## File Attachments ##
34+
### File Attachments
4235
The File Upload/Attachments Settings section allows users to manage file attachments within the Comfort Job plugin, particularly for the Log component. These settings ensure that file uploads are handled securely and efficiently, aligning with your operational requirements.
4336

4437
**Enable File Attachments:** Dropdown to enable disable file attachment feature for log component.\
4538
**Allowed File Types:** Dropdown or multi-select field to specify permitted file types (e.g., PDF, JPG, PNG)\
4639
**Max File Size (MB):** A numeric field where users can define the maximum allowable file size for uploads, measured in megabytes (MB).
4740

48-
## Component Settings ##
49-
The Component Settings section in the Comfort Job plugin offers comprehensive customization options for managing each component key feature. These settings are designed to provide users with full control over the behavior and **configuration of individual components**, ensuring the plugin meets diverse accounting requirements.
41+
Other options like **Show login form for guest user**, **Guest User Login Form**, **Show Register link to guest**, **Allow Edit Protected Logs**, **On Uninstall delete plugin data** are self introductory. Labels are there to guide.
5042

51-
**[PRO]**\
52-
For pro addon **Comfort Job Reports** will add two option **Report Settings** & **Export Settings**\
53-
For pro addom **Comfort Job Woo** will add option **Woocommerce**
43+
## Pages ##
44+
Select the page where you have placed the shortcodes.
5445

55-
## Woocommerce ##
56-
The WooCommerce Integration Settings section is designed to manage the seamless synchronization between WooCommerce and Comfort Job. With configurable options, you can tailor the integration to align with your specific operational needs.
5746

58-
**Enable/Disable WooCommerce Integration:** Checkbox to activate or deactivate the WooCommerce integration.\
59-
**Agency Selection:** Input field to set an agency. This option is mandatory to associate WooCommerce transactions with a specific agency in the system.\
60-
**Associate Bank Account:** Checkbox to enable or disable the association of WooCommerce transactions with a specific bank account.\
61-
**Bank Account Selection:** Input field to set the bank account for associating WooCommerce transactions.\
62-
**Insert New Customer as Client:** Checkbox to automatically add new WooCommerce customers as clients in the Vendors/Clients area.\ -->
6347

6448

docs/comfortjob/user-guide/tools-manager.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,25 @@
22
title: "Comfort Job Documentation"
33
description: "Comfort Job index description."
44
keywords: "Comfort Job index keywords."
5-
url: "/comfortjob/"
5+
url: "/comfortjob/user-guide/tools-manager"
66
type: "type"
77
site_name: "Comfort HRM"
88
image: "https://comforthrm.com/assets/images/seo.png"
99
card: "article"
1010

1111
---
1212

13-
# Comfort Job User Guide
13+
# Tools Manager
1414

15-
Welcome to the Comfort Job Tools Manager.
15+
The Tools Manager provides essential utilities for managing **system data** and configurations within the platform. It offers two powerful features to enhance data management and ensure smooth operations. These tools help users maintain the integrity of their system and migrate database table.
1616

17+
## Options ##
18+
19+
**Reset Option Data**:
20+
+ The Reset Option Data feature allows users to **reset specific option** data within the system. Users can view the available options and choose which one to reset. This feature ensures that users can easily clear outdated or incorrect option data, restoring the system to its default or desired state.
21+
22+
**Migration Files**:
23+
+ The Migration Files feature provides users with visibility into which migration files have been successfully migrated and which have not. Users can also initiate **migrations directly** from this section, allowing for streamlined data transfer and system updates. This functionality is crucial for maintaining data consistency during system upgrades or migrations.
24+
25+
The Tools Manager is an integral part of the system, offering critical utilities to **keep data organized**, ensure smooth migrations. These features enhance data integrity and improve the overall functionality of the system.
1726

0 commit comments

Comments
 (0)