Skip to content

Commit 56235ca

Browse files
authored
Update metadata files (#283)
* Update metadata files * Update description for .yml files
1 parent 747531c commit 56235ca

File tree

10 files changed

+532
-443
lines changed

10 files changed

+532
-443
lines changed

.github/ISSUE_TEMPLATE/00-bug.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ body:
4343
Select the module or modules the problem affects.
4444
multiple: true
4545
options:
46+
- AIShell
4647
- Crescendo
4748
- PlatyPS
4849
- PSScriptAnalyzer

.github/ISSUE_TEMPLATE/01-article.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ body:
3232
Select the module or modules this documentation is for.
3333
multiple: true
3434
options:
35+
- AIShell
3536
- Crescendo
3637
- PlatyPS
3738
- PSScriptAnalyzer

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: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# Contributor Guide
2+
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.
5+
6+
The process for contributing to this project is documented in our
7+
[Contributor's Guide](https://aka.ms/PSDocsContributor).
8+
9+
## PowerShell-Docs-Modules 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+
We only maintain documentation for the current release of these modules.
18+
19+
### Reference content
20+
21+
The reference content is the PowerShell cmdlet reference for the DSC cmdlets. The cmdlet reference
22+
for the various modules is collected in the `reference/ps-modules` folder. This content is also used
23+
to create the help information displayed by the `Get-Help` cmdlet.
24+
25+
### Conceptual content
26+
27+
The conceptual documentation is also organized by module or product.
28+
29+
> [!NOTE]
30+
> Anytime a conceptual article is added, removed, or renamed, the TOC must be updated and deleted or
31+
> renamed files must be redirected.
32+
33+
### Metadata files
34+
35+
This project contains several types of metadata files. The metadata files control the behavior of
36+
our build tools and the publishing system. Only PowerShell-Docs maintainers and approved
37+
contributors are allowed to change these files. If you think that a meta file should be changed,
38+
open an issue to discuss the needed changes.
39+
40+
Meta files in the root of the repository
41+
42+
- `.*` - configuration files in the root of the repository
43+
- `*.md` - Project documentation in the root of the repository
44+
- `*.yml` - build automation files
45+
- `.devcontainer/*` - devcontainer configuration files
46+
- `.github/**/*` - GitHub templates, actions, and other meta files
47+
- `.vscode/**/*` - VS Code extension configurations
48+
- `breadcrumb/*` - breadcrumb navigation configuration
49+
50+
Meta files in the documentation set
51+
52+
- `reference/**/*.json` - docset configuration files
53+
- `reference/**/*.yml` - TOC and other structured content files
54+
- `reference/**/*.ps1` - Example DSC resources and configurations
55+
- `reference/breadcrumb/*` - breadcrumb navigation configuration
56+
- `reference/includes/*` - markdown include files
57+
- `reference/mapping/*` - version mapping configuration
58+
- `reference/**/media/**` - image files used in documentation

0 commit comments

Comments
 (0)