Skip to content

Commit 8b7fa53

Browse files
Fix formatting and enhance definitions in the PSModule Dictionary
1 parent 51ce278 commit 8b7fa53

File tree

1 file changed

+40
-39
lines changed

1 file changed

+40
-39
lines changed

docs/Dictionary/index.md

Lines changed: 40 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,11 @@ Welcome to the PSModule Dictionary - a comprehensive glossary of terms, concepts
77
Common terms you might encounter:
88
- [API](#api) - Application Programming Interface
99
- [Azure](#azure) - Microsoft's cloud platform
10-
- [CI/CD](#ci-cd) - Continuous Integration/Continuous Deployment
10+
- [CI/CD](#cicd) - Continuous Integration/Continuous Deployment
1111
- [Cmdlet](#cmdlet) - PowerShell command
1212
- [Git](#git) - Version control system
1313
- [GitHub](#github) - Code hosting platform
14+
- [LTS](#lts) - Long-Term Servicing
1415
- [MkDocs](#mkdocs) - Documentation generator
1516
- [Module](#module) - PowerShell package
1617
- [Pipeline](#pipeline) - Automated process chain
@@ -26,71 +27,71 @@ This dictionary serves as a reference for developers, contributors, and users to
2627

2728
## A
2829

29-
### API (Application Programming Interface) {#api}
30-
A set of protocols, routines, and tools for building software applications. APIs specify how software components should interact and are used when programming graphical user interface (GUI) components.
30+
### API
31+
Application Programming Interface (API) - A set of protocols, routines, and tools for building software applications. APIs specify how software components should interact and are used when programming graphical user interface (GUI) components.
3132

3233
**Example**: The [GitHub](#github) API allows developers to interact with GitHub repositories, issues, and pull requests programmatically.
3334

34-
### Azure {#azure}
35+
### Azure
3536
Microsoft's cloud computing platform that provides a wide range of cloud services, including compute, analytics, storage, and networking.
3637

3738
**Related**: [Azure Functions](#azure-functions), [Azure DevOps](#azure-devops)
3839

39-
### Azure DevOps {#azure-devops}
40+
### Azure DevOps
4041
A set of development tools and services from Microsoft for software development teams, including version control, build automation, and project management.
4142

42-
### Azure Functions {#azure-functions}
43+
### Azure Functions
4344
A serverless compute service that lets you run event-triggered code without having to explicitly provision or manage infrastructure.
4445

4546
---
4647

4748
## B
4849

49-
### Branch {#branch}
50+
### Branch
5051
In version control systems like [Git](#git), a branch is a parallel version of a [repository](#repository) that diverges from the main working project.
5152

5253
**Example**: Feature branches are used to develop new features in isolation before merging back to the main branch.
5354

54-
### Build Pipeline {#build-pipeline}
55+
### Build Pipeline
5556
An automated process that compiles, tests, and packages source code into deployable artifacts.
5657

5758
---
5859

5960
## C
6061

61-
### CI/CD (Continuous Integration/Continuous Deployment) {#ci-cd}
62-
A software development practice where developers regularly merge their code changes into a central repository, after which automated builds and tests are run.
62+
### CI/CD
63+
Continuous Integration/Continuous Deployment (CI/CD) - A software development practice where developers regularly merge their code changes into a central repository, after which automated builds and tests are run.
6364

64-
### Cmdlet {#cmdlet}
65+
### Cmdlet
6566
A lightweight [PowerShell](#powershell) command that follows the verb-noun naming convention and is designed to perform a specific function.
6667

6768
**Example**: `Get-Process`, `Set-Location`, `New-Item`
6869

69-
### Container {#container}
70+
### Container
7071
A lightweight, standalone, executable package that includes everything needed to run an application: code, runtime, system tools, libraries, and settings.
7172

7273
---
7374

7475
## D
7576

76-
### DevOps {#devops}
77+
### DevOps
7778
A set of practices that combines software development (Dev) and IT operations (Ops) to shorten the systems development life cycle and provide continuous delivery.
7879

79-
### Docker {#docker}
80+
### Docker
8081
A platform for developing, shipping, and running applications using containerization technology.
8182

8283
---
8384

8485
## G
8586

86-
### Git {#git}
87+
### Git
8788
A distributed version control system for tracking changes in source code during software development.
8889

89-
### GitHub {#github}
90+
### GitHub
9091
A web-based platform for version control and collaboration that lets you and others work together on projects from anywhere.
9192

92-
### GitHub Actions {#github-actions}
93-
[GitHub's](#github) built-in [CI/CD](#ci-cd) platform that allows you to automate your build, test, and deployment [pipeline](#pipeline).
93+
### GitHub Actions
94+
[GitHub's](#github) built-in [CI/CD](#cicd) platform that allows you to automate your build, test, and deployment [pipeline](#pipeline).
9495

9596
**Example**: Automatically running tests when a [pull request](#pull-request) is created.
9697

@@ -99,82 +100,82 @@ A web-based platform for version control and collaboration that lets you and oth
99100
## L
100101

101102
### LTS
102-
Long-Term Servicing.
103+
Long-Term Servicing (LTS).
103104
For more info visit: [PowerShell Support Lifecycle](https://learn.microsoft.com/en-us/powershell/scripting/install/powershell-support-lifecycle?view=powershell-7.5)
104105

105106
---
106107

107108
## M
108109

109-
### Markdown {#markdown}
110+
### Markdown
110111
A lightweight markup language with plain text formatting syntax, designed to be converted to HTML and many other formats.
111112

112-
### MkDocs {#mkdocs}
113+
### MkDocs
113114
A fast, simple static site generator that's geared towards building project documentation using [Markdown](#markdown) files.
114115

115-
### Module {#module}
116+
### Module
116117
In [PowerShell](#powershell), a package that contains PowerShell members, such as [cmdlets](#cmdlet), providers, functions, workflows, variables, and aliases.
117118

118119
---
119120

120121
## P
121122

122-
### Pipeline {#pipeline}
123+
### Pipeline
123124
A series of automated processes that allow developers and [DevOps](#devops) professionals to reliably and efficiently compile, build, and deploy their code.
124125

125-
### PowerShell {#powershell}
126+
### PowerShell
126127
A task automation and configuration management framework from Microsoft, consisting of a command-line shell and the associated scripting language.
127128

128-
### Pull Request (PR) {#pull-request}
129-
A method of submitting contributions to a software project where changes are proposed and reviewed before being merged into the main codebase.
129+
### Pull Request
130+
Pull Request (PR) - A method of submitting contributions to a software project where changes are proposed and reviewed before being merged into the main codebase.
130131

131132
---
132133

133134
## R
134135

135-
### Repository (Repo) {#repository}
136-
A storage location for software packages, often used in version control systems to store project files and their revision history.
136+
### Repository
137+
Repository (Repo) - A storage location for software packages, often used in version control systems to store project files and their revision history.
137138

138-
### REST API {#rest-api}
139+
### REST API
139140
An architectural style for designing web services that uses HTTP requests to GET, PUT, POST, and DELETE data.
140141

141142
---
142143

143144
## S
144145

145-
### Semantic Versioning (SemVer) {#semantic-versioning}
146-
A versioning scheme that uses a three-part version number: MAJOR.MINOR.PATCH, where each part is incremented based on the type of changes made.
146+
### Semantic Versioning
147+
Semantic Versioning (SemVer) - A versioning scheme that uses a three-part version number: MAJOR.MINOR.PATCH, where each part is incremented based on the type of changes made.
147148

148149
**Example**: Version 1.2.3 where 1 is major, 2 is minor, and 3 is patch.
149150

150-
### Static Site Generator {#static-site-generator}
151+
### Static Site Generator
151152
A tool that generates a full static HTML website based on raw data and a set of templates.
152153

153154
---
154155

155156
## T
156157

157-
### Template {#template}
158+
### Template
158159
A pre-designed format or structure that can be used as a starting point for creating new files, projects, or configurations.
159160

160-
### Testing {#testing}
161+
### Testing
161162
The process of evaluating and verifying that a software application or system meets specified requirements and functions correctly.
162163

163164
---
164165

165166
## V
166167

167-
### Version Control {#version-control}
168+
### Version Control
168169
A system that records changes to a file or set of files over time so that you can recall specific versions later.
169170

170-
### Virtual Environment {#virtual-environment}
171+
### Virtual Environment
171172
An isolated environment that allows you to install packages and dependencies without affecting the global system installation.
172173

173174
---
174175

175176
## W
176177

177-
### Workflow {#workflow}
178+
### Workflow
178179
A series of automated steps or processes that execute in response to specific events or triggers.
179180

180181
**Example**: A [GitHub Actions](#github-actions) workflow that runs tests every time code is pushed to a [repository](#repository).
@@ -183,8 +184,8 @@ A series of automated steps or processes that execute in response to specific ev
183184

184185
## Y
185186

186-
### YAML (YAML Ain't Markup Language) {#yaml}
187-
A human-readable data serialization standard commonly used for configuration files and data exchange.
187+
### YAML
188+
YAML Ain't Markup Language (YAML) - A human-readable data serialization standard commonly used for configuration files and data exchange.
188189

189190
**Example**: [GitHub Actions](#github-actions) workflows are defined using [YAML](#yaml) files.
190191

0 commit comments

Comments
 (0)