From 02e598acbe8918f8adcfda63ea3eee10985425b3 Mon Sep 17 00:00:00 2001 From: panavdua <114715893+panavdua@users.noreply.github.com> Date: Thu, 13 Apr 2023 18:02:12 +0800 Subject: [PATCH 1/5] Add Glossary section to the UG --- docs/UserGuide.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 6708f06d04e..cdd4deced82 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -616,3 +616,16 @@ This table describes the requirements for the input format of the fields. | **Exit** | `exit` | | **Clear** | `clear` | | **Filter** | `filter FILTER_PARAMETER BOOLEAN_OPERATOR COMPARISON_AMOUNT`
e.g., `filter pr > 1500` | + +-------------------------------------------------------------------------------------------------------------------- + +## Glossary + +- **HR**: _Human Resources_ department of a company responsible for managing employee life cycle and administering employee benefits. +- **HR Manager**: _Human Resource Manager_ will lead and direct the routine functions of the Human Resources (HR) department including hiring and interviewing staff, administering pay, benefits, and leave, and enforcing company policies and practices. +- **CLI**: _Command Line Interface (CLI)_ is a text-based user interface (UI) used to run programs, manage computer files and interact with the computer. +- **GUI**: _Graphical User Interface (GUI)_ is a digital interface in which a user interacts with graphical components such as icons, buttons, and menus. +- **Hard Disk**: _Hard Disk_ is a kind of technology that stores the operating system, applications, and data files such a documents, pictures and music that your computer uses. +- **JAR**: JAR stands for _Java ARchive_. It's a file format based on the popular ZIP file format and is used for aggregating many files into one. +- **CSV**: _Comma-Separated Values (CSV)_ file is a text file that has a specific format which allows data to be saved in a table structured format. +- \ No newline at end of file From 151b8a9efb464cce94710ea40cf3f75031d57593 Mon Sep 17 00:00:00 2001 From: panavdua <114715893+panavdua@users.noreply.github.com> Date: Thu, 13 Apr 2023 18:07:37 +0800 Subject: [PATCH 2/5] Typo fix --- docs/UserGuide.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index cdd4deced82..9c7d431dc87 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -628,4 +628,3 @@ This table describes the requirements for the input format of the fields. - **Hard Disk**: _Hard Disk_ is a kind of technology that stores the operating system, applications, and data files such a documents, pictures and music that your computer uses. - **JAR**: JAR stands for _Java ARchive_. It's a file format based on the popular ZIP file format and is used for aggregating many files into one. - **CSV**: _Comma-Separated Values (CSV)_ file is a text file that has a specific format which allows data to be saved in a table structured format. -- \ No newline at end of file From e30cc4469e6b519c98fa0aefcdeb0fdbf6894272 Mon Sep 17 00:00:00 2001 From: panavdua <114715893+panavdua@users.noreply.github.com> Date: Thu, 13 Apr 2023 18:20:33 +0800 Subject: [PATCH 3/5] Add more definitions --- docs/UserGuide.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 9c7d431dc87..be972de6b0c 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -625,6 +625,7 @@ This table describes the requirements for the input format of the fields. - **HR Manager**: _Human Resource Manager_ will lead and direct the routine functions of the Human Resources (HR) department including hiring and interviewing staff, administering pay, benefits, and leave, and enforcing company policies and practices. - **CLI**: _Command Line Interface (CLI)_ is a text-based user interface (UI) used to run programs, manage computer files and interact with the computer. - **GUI**: _Graphical User Interface (GUI)_ is a digital interface in which a user interacts with graphical components such as icons, buttons, and menus. +- **Terminal/Command Prompt**: _Terminal_ and _Command Prompt_ are interfaces which let you access the command line. - **Hard Disk**: _Hard Disk_ is a kind of technology that stores the operating system, applications, and data files such a documents, pictures and music that your computer uses. - **JAR**: JAR stands for _Java ARchive_. It's a file format based on the popular ZIP file format and is used for aggregating many files into one. - **CSV**: _Comma-Separated Values (CSV)_ file is a text file that has a specific format which allows data to be saved in a table structured format. From fac547f5b5457743faa59896c529cf6f7c6b7e1f Mon Sep 17 00:00:00 2001 From: panavdua <114715893+panavdua@users.noreply.github.com> Date: Thu, 13 Apr 2023 18:38:13 +0800 Subject: [PATCH 4/5] Add JSON definition --- docs/UserGuide.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index be972de6b0c..51318fdee7a 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -629,3 +629,4 @@ This table describes the requirements for the input format of the fields. - **Hard Disk**: _Hard Disk_ is a kind of technology that stores the operating system, applications, and data files such a documents, pictures and music that your computer uses. - **JAR**: JAR stands for _Java ARchive_. It's a file format based on the popular ZIP file format and is used for aggregating many files into one. - **CSV**: _Comma-Separated Values (CSV)_ file is a text file that has a specific format which allows data to be saved in a table structured format. +- **JSON**: _JavaScript Object Notation (JSON)_ is a standard text-based format for representing structured data and is commonly used for transmitting data in web applications. \ No newline at end of file From 9c4b5fdb19cf450c8414f17cafeae85589533616 Mon Sep 17 00:00:00 2001 From: panavdua <114715893+panavdua@users.noreply.github.com> Date: Thu, 13 Apr 2023 18:39:29 +0800 Subject: [PATCH 5/5] Checkstyle fix --- docs/UserGuide.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 51318fdee7a..cd55dc0e0ad 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -629,4 +629,5 @@ This table describes the requirements for the input format of the fields. - **Hard Disk**: _Hard Disk_ is a kind of technology that stores the operating system, applications, and data files such a documents, pictures and music that your computer uses. - **JAR**: JAR stands for _Java ARchive_. It's a file format based on the popular ZIP file format and is used for aggregating many files into one. - **CSV**: _Comma-Separated Values (CSV)_ file is a text file that has a specific format which allows data to be saved in a table structured format. -- **JSON**: _JavaScript Object Notation (JSON)_ is a standard text-based format for representing structured data and is commonly used for transmitting data in web applications. \ No newline at end of file +- **JSON**: _JavaScript Object Notation (JSON)_ is a standard text-based format for representing structured data and is commonly used for transmitting data in web applications. +