11---
22description : This article is an overview of how to get started as a contributor to the PowerShell documentation.
3- ms.date : 07/26/2022
3+ ms.date : 01/03/2025
44title : Get started contributing to PowerShell documentation
55---
66# Get started contributing to PowerShell documentation
@@ -15,7 +15,7 @@ conceptual.
1515### Reference content
1616
1717The reference content is the PowerShell cmdlet reference for the cmdlets that ship in PowerShell.
18- The cmdlet [ reference] [ 2 ] is collected in versioned folders (like 5.1, 7.0 , and 7.2 ), which contain
18+ The cmdlet [ reference] [ 2 ] is collected in versioned folders (like 5.1, 7.4 , and 7.5 ), which contain
1919reference for the modules that ship with PowerShell. This content is also used to create the help
2020information displayed by the ` Get-Help ` cmdlet.
2121
@@ -28,6 +28,36 @@ version of PowerShell.
2828> Anytime a conceptual article is added, removed, or renamed, the TOC must be updated and deleted or
2929> renamed files must be redirected.
3030
31+ ### Metadata files
32+
33+ This project contains several types of metadata files. The metadata files control the behavior of
34+ our build tools and the publishing system. Only PowerShell-Docs maintainers and approved
35+ contributors are allowed to change these files. If you think that a meta file should be changed,
36+ open an issue to discuss the needed changes.
37+
38+ Meta files in the root of the repository
39+
40+ - ` .* ` - configuration files in the root of the repository
41+ - ` *.md ` - Project documentation in the root of the repository
42+ - ` *.yml ` - Project documentation in the root of the repository
43+ - ` .devcontainer/* ` - devcontainer configuration files
44+ - ` .github/**/* ` - GitHub templates, actions, and other meta files
45+ - ` .vscode/**/* ` - VS Code extension configurations
46+ - ` assets/* ` - contains downloadable files linked in the documentation
47+ - ` redir/* ` - contain redirection mapping files
48+ - ` tests/* ` - test tools used by the build system
49+ - ` tools/* ` - other tools used by the build system
50+
51+ Meta files in the documentation set
52+
53+ - ` reference/**/*.json ` - docset configuration files
54+ - ` reference/**/*.yml ` - TOC and other structured content files
55+ - ` reference/bread/* ` - breadcrumb navigation configuration
56+ - ` reference/includes/* ` - markdown include files
57+ - ` reference/mapping/* ` - version mapping configuration
58+ - ` reference/**/media/** ` - image files used in documentation
59+ - ` reference/module/* ` - Module Browser page configuration
60+
3161## Creating new articles
3262
3363A GitHub issue must be created for any new document you want to contribute. Check for existing
0 commit comments