From 99a2070d4a267a02cac96e2c7b91525c3022b312 Mon Sep 17 00:00:00 2001 From: Paul Broadwith Date: Fri, 21 Jul 2023 17:12:21 +0100 Subject: [PATCH 1/2] (#794) Add Jargon Buster page --- input/en-us/information/jargon-buster.md | 39 ++++++++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 input/en-us/information/jargon-buster.md diff --git a/input/en-us/information/jargon-buster.md b/input/en-us/information/jargon-buster.md new file mode 100644 index 0000000000..ab1b0a89bb --- /dev/null +++ b/input/en-us/information/jargon-buster.md @@ -0,0 +1,39 @@ +--- +Order: 60 +xref: jargon-buster +Title: Jargon Buster +Description: A reference guide on the jargon and acronyms used in our documentation. +--- + +While a goal for our documentation is clarity we recognize that as engineers and technical users of our software, we speak and write in a manner that may not always be as clear to others as we would like. + +One of our goals for writing documentation, is clarity. As we update our documentation we strive to bring clarity to it. But this is a work in-progress. We recognize that jargon and acronyms can cause confusion, misunderstanding and act as a barrier for those who are getting started with our software. + +This guide aims to define the common jargon and acronyms used in our documentation. It contains both Chocolatey specific, and more general computer jargon and acronyms. + +If you feel a definition is missing, unclear or could be better, please raise an issue on our [Documentation GitHub repository](https://github.com/chocolatey/docs). + +## Jargon Busted. Acronyms Defined. + +### A + +* **AV**. Shorthand term for 'antivirus'. Commonly used in phrases such as 'AV software' or 'AV detections'. + +### C + +* **CCM**. A shorthand term for [Chocolatey Central Management](xref:central-management). +* **CCR**. Shorthands for [Chocolatey Community Repository](https://community.chocolatey.org). This is the repository that hosts community maintained Chocolatey packages. +* **Central Management**. Another shorthand term used to mean [Chocolatey Central Management](xref:central-management). +* **choco**. This is a commonly used shorthand term for [Chocolatey CLI](aref:choco) or more specifically, the Chocolatey CLI command run from the command line. For example, to install a package you would use `choco install `. +* **Chocolatey**. This is another commonly used term to refer to [Chocolatey CLI](xref:choco). It is also commonly used to refer to the Chocolatey suite of products as a whole. We now try to be clearer by referring to Chocolatey CLI specifically when we need to. +* **CLI**. This is shorthand for [Command Line Interface](https://en.wikipedia.org/wiki/Command-line_interface) and refers to interacting with an application from a terminal by typing commands. + +### N + +* **NuGet**. Refers to the tool and framework used to install [NuGet packages](https://nuget.org). The Chocolatey packaging framework is based on the NuGet packaging framework. +* **nupkg**. A Chocolatey package file has the extension `nupkg` and this is a shorthand term referring to the package file. + +### V + +* **VirusTotal**. A service that scans submitted files against over [70 antivirus scanners and URL / blocklisting services](https://support.virustotal.com/hc/en-us/articles/115002126889-How-it-works). The [VirusTotal](https://virustotal.com) results for each Chocolatey Community Repository package are shown under the Virus Scan Results section. +* **VT**. Shorthand for [VirusTotal](https://virustotal.com). See the definition for VirusTotal. From 118d69443e99d7b42f4f03637f88129f524cd82a Mon Sep 17 00:00:00 2001 From: Paul Broadwith Date: Fri, 4 Aug 2023 15:15:51 +0100 Subject: [PATCH 2/2] rebase --- input/en-us/information/jargon-buster.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/input/en-us/information/jargon-buster.md b/input/en-us/information/jargon-buster.md index ab1b0a89bb..0048b61580 100644 --- a/input/en-us/information/jargon-buster.md +++ b/input/en-us/information/jargon-buster.md @@ -1,8 +1,8 @@ --- -Order: 60 +Order: 55 xref: jargon-buster Title: Jargon Buster -Description: A reference guide on the jargon and acronyms used in our documentation. +Description: A reference guide on the jargon and acronyms used in our documentation --- While a goal for our documentation is clarity we recognize that as engineers and technical users of our software, we speak and write in a manner that may not always be as clear to others as we would like. @@ -28,10 +28,15 @@ If you feel a definition is missing, unclear or could be better, please raise an * **Chocolatey**. This is another commonly used term to refer to [Chocolatey CLI](xref:choco). It is also commonly used to refer to the Chocolatey suite of products as a whole. We now try to be clearer by referring to Chocolatey CLI specifically when we need to. * **CLI**. This is shorthand for [Command Line Interface](https://en.wikipedia.org/wiki/Command-line_interface) and refers to interacting with an application from a terminal by typing commands. +### M + +* **metadata**. + ### N * **NuGet**. Refers to the tool and framework used to install [NuGet packages](https://nuget.org). The Chocolatey packaging framework is based on the NuGet packaging framework. * **nupkg**. A Chocolatey package file has the extension `nupkg` and this is a shorthand term referring to the package file. +* **nuspec**. A Chocolatey package file that has the extension `nuspec`. This file contains the package metadata. ### V