Skip to content

Commit 23a6be4

Browse files
deepakdebdeepakdeb
committed
resume user guide on process
1 parent 26cdd39 commit 23a6be4

File tree

9 files changed

+365
-7
lines changed

9 files changed

+365
-7
lines changed

‎docs/.vitepress/config.ts‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -155,11 +155,12 @@ export default {
155155
collapsible: true,
156156
items: [
157157
{ text: 'General', link: '/comfortresume/user-guide/general' },
158-
{ text: 'Settings Manager', link: '/comfortresume/user-guide/settings-manager' },
159-
{ text: 'Agency Manager', link: '/comfortresume/user-guide/agency-manager' },
160-
{ text: 'Account Manager', link: '/comfortresume/user-guide/account-manager' },
161-
{ text: 'Category Manager', link: '/comfortresume/user-guide/category-manager' },
158+
{ text: 'Job Manager', link: '/comfortresume/user-guide/resume-manager' },
159+
{ text: 'Settings Manager', link: '/comfortresume/user-guide/settings' },
160+
{ text: 'Job Category', link: '/comfortresume/user-guide/resume-category' },
161+
{ text: 'Job Tags', link: '/comfortresume/user-guide/resume-tags' },
162162
{ text: 'Tools Manager', link: '/comfortresume/user-guide/tools-manager' },
163+
{ text: 'Emails', link: '/comfortresume/user-guide/emails' },
163164
],
164165
}
165166
],

‎docs/comfortjob/user-guide/job-tags.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@ card: "article"
1010

1111
---
1212

13-
### Job Categories
13+
### Job Tags
1414

15-
1. Go to `Comfort Job > Job Categories`.
16-
2. Add new job categories by filling in the name and description.
15+
1. Go to `Comfort Job > Job Tags`.
16+
2. Add new job tags by filling in the name and description.
1717
3. Save changes.
1818

1919

‎docs/comfortresume/user-guide/emails.md‎

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: "Documentation for Comfort Job"
4+
keywords: "comfort job, wordpress, wordpress job plugin, plugin"
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/comfortresume/user-guide/general.md‎

Lines changed: 167 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,167 @@
1+
---
2+
title: "Comfort Resume Documentation"
3+
description: "Documentation for Comfort Resume"
4+
keywords: "Comfort Resume index keywords."
5+
url: "/resume/user-guide/general"
6+
type: "type"
7+
site_name: "Comfort HRM"
8+
image: "https://comforthrm.com/assets/images/seo.png"
9+
card: "article"
10+
11+
---
12+
13+
# Comfort Resume User Guide
14+
15+
The Comfort Resume plugin is designed to simplify resume/CV management within WordPress. It provides features for resume listings, resume builder related functionalities.
16+
17+
## File Structure
18+
19+
```
20+
resume/
21+
├── assets/
22+
│ ├── css/
23+
│ ├── js/
24+
│ ├── vendors/
25+
├── includes/
26+
│ ├── Api/
27+
│ ├── Controllers/
28+
│ ├── Helpers/
29+
│ ├── Models/
30+
│ ├── ComfortResume.php
31+
│ ├── ComfortResumeAdmin.php
32+
│ ├── ComfortResumeHooks.php
33+
│ ├── ComfortResumePublic.php
34+
│ ├── ComfortResumeShortcode.php
35+
│ └── ComfortResumeUninstall.php
36+
├── templates/
37+
│ ├── admin/
38+
│ ├── global/
39+
│ ├── resume/
40+
│ └── shortcodes/
41+
├── resume.php
42+
└── readme.txt
43+
```
44+
## Key Files and Directories
45+
46+
- **assets/**: Contains CSS, JavaScript, and vendor files.
47+
- **includes/**: Contains core PHP files for the plugin, including API routes, controllers, helpers, models, and main plugin classes.
48+
- **templates/**: Contains template files for the plugin's frontend and admin views.
49+
- **resume.php**: The main plugin file that initializes the plugin.
50+
51+
### ComfortResume
52+
53+
The main class for the plugin, located in `wp-content/plugins/resume/includes/ComfortResume.php`.
54+
55+
```php
56+
class ComfortResume {
57+
public static function instance() {
58+
// Returns the main instance of ComfortResume.
59+
}
60+
61+
public function __construct() {
62+
// Constructor method.
63+
}
64+
65+
private function include_files() {
66+
// Includes necessary files.
67+
}
68+
}
69+
```
70+
### ComfortResumeAdmin
71+
Handles the admin functionalities of the plugin, located in `ComfortResumeAdmin.php`.
72+
73+
```
74+
<?php
75+
class ComfortResumeAdmin {
76+
public function create_menus() {
77+
// Creates admin menus.
78+
}
79+
80+
public function display_resume_listing_page() {
81+
// Displays the resume listing page.
82+
}
83+
}
84+
```
85+
### ComfortResumePublic
86+
Handles the public-facing functionalities of the plugin, located in `ComfortResumePublic.php`.
87+
88+
```
89+
<?php
90+
class ComfortResumePublic {
91+
public function enqueue_scripts() {
92+
// Enqueues public scripts and styles.
93+
}
94+
}
95+
```
96+
### ComfortResumeShortcode
97+
Handles the public-facing functionalities of the plugin, located in `ComfortResumeShortcode.php`.
98+
99+
```
100+
<?php
101+
class ComfortResumeShortcode {
102+
public function init_shortcode() {
103+
// Initializes shortcodes.
104+
}
105+
106+
public function resume_resume_details_shortcode($atts) {
107+
// Handles the resume details shortcode.
108+
}
109+
}
110+
```
111+
112+
### Job Details
113+
114+
To display resume details, use the following shortcode:
115+
116+
```php
117+
[resume_resume_details]
118+
```
119+
120+
### Job Archive
121+
122+
To display a list of resume listings, use the following shortcode:
123+
124+
```php
125+
[resume_resume_archive]
126+
```
127+
128+
### Employer Dashboard
129+
130+
To display the employer dashboard, use the following shortcode:
131+
132+
```php
133+
[resume_employer_dashboard]
134+
```
135+
136+
### Candidate Dashboard
137+
138+
To display the candidate dashboard, use the following shortcode:
139+
140+
```php
141+
[resume_candidate_dashboard]
142+
```
143+
144+
### Job Dashboard
145+
146+
To display the resume dashboard, use the following shortcode:
147+
148+
```php
149+
[resume_resume_dashboard]
150+
```
151+
152+
### Frontend Job Management
153+
154+
1. Create a new page in WordPress.
155+
2. Add the `[resume_resume_manager]` shortcode to the page content.
156+
3. Publish the page.
157+
4. Users can now submit resume listings from the frontend.
158+
159+
160+
## Uninstallation
161+
162+
The uninstallation script is located in ComfortResumeUninstall.php.
163+
164+
```
165+
<?php
166+
do_action('resume_plugin_uninstall');
167+
```

‎docs/comfortresume/user-guide/resume-category.md‎

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: "Documentation for Comfort Job"
4+
keywords: "comfort job, wordpress, wordpress job plugin, plugin"
5+
url: "/comfortjob/user-guide/job-category"
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/comfortresume/user-guide/resume-manager.md‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
title: "Comfort Job Documentation"
3+
description: "Documentation for Comfort Job"
4+
keywords: "comfort job, wordpress, wordpress job plugin, plugin"
5+
url: "/comfortjob/user-guide/job-manager"
6+
type: "type"
7+
site_name: "Comfort HRM"
8+
image: "https://comforthrm.com/assets/images/seo.png"
9+
card: "article"
10+
11+
---
12+
13+
## Managing Job Listings
14+
15+
1. Go to `Comfort Job > Job Manager`.
16+
2. View, edit, or delete job listings as needed.
17+
3. Use the filters to search for specific job listings.
18+
19+
## Adding Job Listings
20+
21+
1. Go to `Comfort Job > Add New Job`.
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.
37+
4. Publish the job listing.

‎docs/comfortresume/user-guide/resume-tags.md‎

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: "Documentation for Comfort Job"
4+
keywords: "comfort job, wordpress, wordpress job plugin, plugin"
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 Tags
14+
15+
1. Go to `Comfort Job > Job Tags`.
16+
2. Add new job tags by filling in the name and description.
17+
3. Save changes.
18+
19+

‎docs/comfortresume/user-guide/settings.md‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
---
2+
title: "Comfort Job Documentation"
3+
description: "Documentation for Comfort Job"
4+
keywords: "comfort job, wordpress, wordpress job plugin, plugin"
5+
url: "/comfortjob/user-guide/settings"
6+
type: "type"
7+
site_name: "Comfort HRM"
8+
image: "https://comforthrm.com/assets/images/seo.png"
9+
card: "article"
10+
11+
---
12+
13+
# Comfort Job User Guide
14+
15+
### General Settings
16+
17+
1. Go to `Comfort Job > Settings`.
18+
2. Configure the general settings such as job listing page, job submission page, and other options.
19+
3. Save changes.
20+
21+
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.
22+
23+
# General Settings Overview #
24+
The Comfort Job plugin is designed with a modular and intuitive settings structure, ensuring that users can easily configure and tailor the plugin to their specific needs. Below is an overview of the key configuration areas:
25+
26+
# Accessing the Settings Panel #
27+
Navigate to **Comfort Job > Settings** in the WordPress admin dashboard. This section is organized into various sections, each dedicated to specific configuration options.
28+
29+
## Basic Settings ##
30+
These fundamental settings allow you to define core parameters for your accounting system. Some key options:
31+
32+
**Pages Slug** Set the slug country for different pages over the plugin.\
33+
34+
### File Attachments
35+
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.
36+
37+
**Enable File Attachments:** Dropdown to enable disable file attachment feature for log component.\
38+
**Allowed File Types:** Dropdown or multi-select field to specify permitted file types (e.g., PDF, JPG, PNG)\
39+
**Max File Size (MB):** A numeric field where users can define the maximum allowable file size for uploads, measured in megabytes (MB).
40+
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.
42+
43+
## Pages ##
44+
Select the page where you have placed the shortcodes.
45+
46+
47+
48+

‎docs/comfortresume/user-guide/tools-manager.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
title: "Comfort Job Documentation"
3+
description: "Documentation for Comfort Job"
4+
keywords: "comfort job, wordpress, wordpress job plugin, plugin"
5+
url: "/comfortjob/user-guide/tools-manager"
6+
type: "type"
7+
site_name: "Comfort HRM"
8+
image: "https://comforthrm.com/assets/images/seo.png"
9+
card: "article"
10+
11+
---
12+
13+
# Tools Manager
14+
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.
16+
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.
26+

0 commit comments

Comments
 (0)