Skip to content

Commit 3e16bd7

Browse files
committed
Update metadata files
1 parent abc2dec commit 3e16bd7

File tree

11 files changed

+537
-456
lines changed

11 files changed

+537
-456
lines changed

.github/ISSUE_TEMPLATE/00-bug.yml

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,9 +43,10 @@ body:
4343
Select the version or versions the problem affects.
4444
multiple: true
4545
options:
46-
- v1
47-
- v2
48-
- v3
46+
- PowerShellGet v1
47+
- PowerShellGet v2
48+
- PowerShellGet v3/PSResourceGet
49+
- PowerShell Gallery
4950
- type: textarea
5051
id: link_list
5152
validations:

.github/ISSUE_TEMPLATE/01-article.yml

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,10 @@ body:
3232
Select the version or versions of DSC this documentation is for.
3333
multiple: true
3434
options:
35-
- v1
36-
- v2
37-
- v3
35+
- PowerShellGet v1
36+
- PowerShellGet v2
37+
- PowerShellGet v3/PSResourceGet
38+
- PowerShell Gallery
3839
- type: textarea
3940
id: summary
4041
validations:

CODE_OF_CONDUCT.md

Lines changed: 40 additions & 6 deletions
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

Lines changed: 52 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,55 @@
11
# Contributor Guide
22

3-
Thank you for your interest in contributing to quality documentations.
4-
As an open source project, we welcome input and updates from the community.
3+
Thank you for your interest in contributing to quality documentations. As an open source project, we
4+
welcome input and updates from the community.
55

6-
Please see our Contributor's Guide at https://aka.ms/PSDocsContributor.
6+
The process for contributing to this project is documented in our
7+
[Contributor's Guide](https://aka.ms/PSDocsContributor).
8+
9+
## PowerShell-Docs-PSGet structure
10+
11+
There are three categories of content in this repository:
12+
13+
- reference content
14+
- conceptual content
15+
- metadata and configuration files
16+
17+
### Reference content
18+
19+
The reference content is the PowerShell cmdlet reference for the PowerShell package management
20+
cmdlets. The cmdlet reference is collected by version in the `powershell-gallery` folder. This
21+
content is also used to create the help information displayed by the `Get-Help` cmdlet.
22+
23+
### Conceptual content
24+
25+
The conceptual documentation isn't organized by version. All articles are displayed for every
26+
version of PowerShell.
27+
28+
> [!NOTE]
29+
> Anytime a conceptual article is added, removed, or renamed, the TOC must be updated and deleted or
30+
> renamed files must be redirected.
31+
32+
### Metadata files
33+
34+
This project contains several types of metadata files. The metadata files control the behavior of
35+
our build tools and the publishing system. Only PowerShell-Docs maintainers and approved
36+
contributors are allowed to change these files. If you think that a meta file should be changed,
37+
open an issue to discuss the needed changes.
38+
39+
Meta files in the root of the repository
40+
41+
- `.*` - configuration files in the root of the repository
42+
- `*.md` - Project documentation in the root of the repository
43+
- `*.yml` - build automation files
44+
- `.devcontainer/*` - devcontainer configuration files
45+
- `.github/**/*` - GitHub templates, actions, and other meta files
46+
- `.vscode/**/*` - VS Code extension configurations
47+
48+
Meta files in the documentation set
49+
50+
- `powershell-gallery/**/*.json` - docset configuration files
51+
- `powershell-gallery/**/*.yml` - TOC and other structured content files
52+
- `powershell-gallery/breadcrumb/*` - breadcrumb navigation configuration
53+
- `powershell-gallery/includes/*` - markdown include files
54+
- `powershell-gallery/mapping/*` - version mapping configuration
55+
- `powershell-gallery/**/media/**` - image files used in documentation

0 commit comments

Comments
 (0)