Skip to content

Commit 98f2518

Browse files
authored
Update repository's meta files (#11624)
* Update repository's meta files * Update contributor guide to list meta files policy * more edits
1 parent 1b73296 commit 98f2518

File tree

5 files changed

+92
-33
lines changed

5 files changed

+92
-33
lines changed

.github/ISSUE_TEMPLATE/01-article.yml

+1-2
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,8 @@ body:
3333
multiple: true
3434
options:
3535
- "5.1"
36-
- "7.2"
37-
- "7.3"
3836
- "7.4"
37+
- "7.5"
3938
- type: textarea
4039
id: summary
4140
validations:

CODE_OF_CONDUCT.md

+40-6
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,44 @@
11
# Microsoft Open Source Code of Conduct
22

3-
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
3+
This project has adopted the [Microsoft Open Source Code of Conduct][02].
44

5-
Resources:
5+
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and
6+
healthy community.
67

7-
- [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/)
8-
- [Microsoft Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/)
9-
- Contact [[email protected]](mailto:[email protected]) with questions or concerns
10-
- Employees can reach out at [aka.ms/opensource/moderation-support](https://aka.ms/opensource/moderation-support)
8+
## Our Standards
9+
10+
Examples of behavior that contributes to a positive environment for our community include:
11+
12+
- Demonstrating empathy and kindness toward other people
13+
- Being respectful of differing opinions, viewpoints, and experiences
14+
- Giving and gracefully accepting constructive feedback
15+
- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the
16+
experience
17+
- Focusing on what's best not just for us as individuals, but for the overall community
18+
19+
Examples of unacceptable behavior include:
20+
21+
- Disruptive behavior
22+
- Submitting spam comments, issues, or pull requests
23+
- Defacing or vandalizing the project, repository, content, or documentation
24+
- Intentionally introducing security vulnerabilities
25+
- Disrespectful behavior
26+
- Trolling, insulting or derogatory comments, and personal or political attacks
27+
- Public or private harassment
28+
- Publishing others' private information, such as a physical or email address, without their
29+
explicit permission
30+
- The use of sexualized language or imagery, and sexual attention or advances of any kind
31+
- Other conduct that could reasonably be considered inappropriate in a professional setting
32+
33+
## Resources
34+
35+
- [Microsoft Open Source Code of Conduct][02]
36+
- [Microsoft Code of Conduct FAQ][03]
37+
- Contact [[email protected]][04] with questions or concerns
38+
- Employees can reach out at [aka.ms/opensource/moderation-support][01]
39+
40+
<!-- link references -->
41+
[01]: https://aka.ms/opensource/moderation-support
42+
[02]: https://opensource.microsoft.com/codeofconduct/
43+
[03]: https://opensource.microsoft.com/codeofconduct/faq/
44+
[04]: mailto:[email protected]

CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,4 @@
33
Thank you for your interest in contributing to quality documentations.
44
As an open source project, we welcome input and updates from the community.
55

6-
Please see our Contributor's Guide at https://aka.ms/PSDocsContributor.
6+
Please see our Contributor's Guide at <https://aka.ms/PSDocsContributor>

README.md

+13-20
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
ms.date: 11/02/2024
2+
ms.date: 01/03/2025
33
---
44
# PowerShell Documentation
55

@@ -9,15 +9,6 @@ Welcome to the PowerShell-Docs repository, the home of the official PowerShell d
99

1010
This project has adopted the [Microsoft Open Source Code of Conduct][04].
1111

12-
## Build Status
13-
14-
[live-badge]: https://powershell.visualstudio.com/PowerShell-Docs/_apis/build/status/PowerShell-Docs-CI?branchName=live
15-
[main-badge]: https://powershell.visualstudio.com/PowerShell-Docs/_apis/build/status/PowerShell-Docs-CI?branchName=main
16-
17-
| live branch | main branch |
18-
| :---------------------------- | :---------------------------- |
19-
| [![live-badge][]][live-badge] | [![main-badge][]][main-badge] |
20-
2112
## PowerShell Updatable Help (CabGen) CI Build Status
2213

2314
[![Build Status][cabgen-status]][cabgen-log]
@@ -29,14 +20,13 @@ This project has adopted the [Microsoft Open Source Code of Conduct][04].
2920

3021
The following list describes the main folders in this repository.
3122

23+
- `.devcontainer` - configuration files for the VS Code Remote - Containers extension
3224
- `.github` - contains configuration settings used by GitHub for this repository
33-
- `.vscode` - contains configuration settings and recommended extensions for Visual Studio Code (VS
34-
Code)
25+
- `.vscode` - contains configuration settings and recommended extensions for VS Code
3526
- `assets` - contains downloadable files linked in the documentation
3627
- `redir` - contain redirection mapping files
37-
- `reference` - contains the documentation published to
38-
[learn.microsoft.com][01]. This includes both
39-
reference and conceptual content.
28+
- `reference` - contains the documentation published to [learn.microsoft.com][01]. This includes
29+
both reference and conceptual content.
4030
- `5.1` - contains the cmdlet reference and about topics for PowerShell 5.1
4131
- `7.4` - contains the cmdlet reference and about topics for PowerShell 7.4
4232
- `7.5` - contains the cmdlet reference and about topics for PowerShell 7.5
@@ -52,9 +42,10 @@ The following list describes the main folders in this repository.
5242
- `tests` - contains the Pester tests used by the build system
5343
- `tools` - contains other tools used by the build system
5444

55-
> NOTE: The reference content (in the numbered folders) is used to create the webpages on the Docs
56-
> site as well as the updateable help used by PowerShell. The articles in the `docs-conceptual`
57-
> folder are only published to the Docs website.
45+
> [!NOTE]
46+
> The reference content (in the numbered folders) is used to create the webpages on the Docs site as
47+
> well as the updateable help used by PowerShell. The articles in the `docs-conceptual` folder are
48+
> only published to the Docs website.
5849
5950
## Contributing
6051

@@ -69,11 +60,13 @@ consistent across versions.
6960

7061
## Licenses
7162

72-
There are two license files for this project. The MIT License applies to the code contained in this
73-
repo. The Creative Commons license applies to the documentation.
63+
There are two license files for this project. The [MIT License][05] applies to the code contained in
64+
this repo. The [Creative Commons license][06] applies to the documentation.
7465

7566
<!-- link references -->
7667
[01]: https://learn.microsoft.com/powershell/scripting/
7768
[02]: https://aka.ms/PSDocsContributor
7869
[03]: https://cla.microsoft.com/
7970
[04]: CODE_OF_CONDUCT.md
71+
[05]: LICENSE-CODE.md
72+
[06]: LICENSE.md

reference/docs-conceptual/community/contributing/get-started-writing.md

+37-4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
description: 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
44
title: Get started contributing to PowerShell documentation
55
---
66
# Get started contributing to PowerShell documentation
@@ -9,13 +9,16 @@ This article is an overview of how to get started as a contributor to the PowerS
99

1010
## PowerShell-Docs structure
1111

12-
The [PowerShell-Docs repository][1] is divided into two groups of content: reference and
13-
conceptual.
12+
There are three categories of content in the [PowerShell-Docs][1] repository:
13+
14+
- reference content
15+
- conceptual content
16+
- metadata and configuration files
1417

1518
### Reference content
1619

1720
The 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
21+
The cmdlet [reference][2] is collected in versioned folders (like 5.1, 7.4, and 7.5), which contain
1922
reference for the modules that ship with PowerShell. This content is also used to create the help
2023
information displayed by the `Get-Help` cmdlet.
2124

@@ -28,6 +31,36 @@ version of PowerShell.
2831
> Anytime a conceptual article is added, removed, or renamed, the TOC must be updated and deleted or
2932
> renamed files must be redirected.
3033
34+
### Metadata files
35+
36+
This project contains several types of metadata files. The metadata files control the behavior of
37+
our build tools and the publishing system. Only PowerShell-Docs maintainers and approved
38+
contributors are allowed to change these files. If you think that a meta file should be changed,
39+
open an issue to discuss the needed changes.
40+
41+
Meta files in the root of the repository
42+
43+
- `.*` - configuration files in the root of the repository
44+
- `*.md` - Project documentation in the root of the repository
45+
- `*.yml` - Project documentation in the root of the repository
46+
- `.devcontainer/*` - devcontainer configuration files
47+
- `.github/**/*` - GitHub templates, actions, and other meta files
48+
- `.vscode/**/*` - VS Code extension configurations
49+
- `assets/*` - contains downloadable files linked in the documentation
50+
- `redir/*` - contain redirection mapping files
51+
- `tests/*` - test tools used by the build system
52+
- `tools/*` - other tools used by the build system
53+
54+
Meta files in the documentation set
55+
56+
- `reference/**/*.json` - docset configuration files
57+
- `reference/**/*.yml` - TOC and other structured content files
58+
- `reference/bread/*` - breadcrumb navigation configuration
59+
- `reference/includes/*` - markdown include files
60+
- `reference/mapping/*` - version mapping configuration
61+
- `reference/**/media/**` - image files used in documentation
62+
- `reference/module/*` - Module Browser page configuration
63+
3164
## Creating new articles
3265

3366
A GitHub issue must be created for any new document you want to contribute. Check for existing

0 commit comments

Comments
 (0)