-
Notifications
You must be signed in to change notification settings - Fork 50
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #284 from MicrosoftDocs/main
1/3/2024 PM Publish
- Loading branch information
Showing
10 changed files
with
532 additions
and
443 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,10 +1,44 @@ | ||
# Microsoft Open Source Code of Conduct | ||
|
||
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). | ||
This project has adopted the [Microsoft Open Source Code of Conduct][02]. | ||
|
||
Resources: | ||
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and | ||
healthy community. | ||
|
||
- [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/) | ||
- [Microsoft Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) | ||
- Contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with questions or concerns | ||
- Employees can reach out at [aka.ms/opensource/moderation-support](https://aka.ms/opensource/moderation-support) | ||
## Our Standards | ||
|
||
Examples of behavior that contributes to a positive environment for our community include: | ||
|
||
- Demonstrating empathy and kindness toward other people | ||
- Being respectful of differing opinions, viewpoints, and experiences | ||
- Giving and gracefully accepting constructive feedback | ||
- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the | ||
experience | ||
- Focusing on what's best not just for us as individuals, but for the overall community | ||
|
||
Examples of unacceptable behavior include: | ||
|
||
- Disruptive behavior | ||
- Submitting spam comments, issues, or pull requests | ||
- Defacing or vandalizing the project, repository, content, or documentation | ||
- Intentionally introducing security vulnerabilities | ||
- Disrespectful behavior | ||
- Trolling, insulting or derogatory comments, and personal or political attacks | ||
- Public or private harassment | ||
- Publishing others' private information, such as a physical or email address, without their | ||
explicit permission | ||
- The use of sexualized language or imagery, and sexual attention or advances of any kind | ||
- Other conduct that could reasonably be considered inappropriate in a professional setting | ||
|
||
## Resources | ||
|
||
- [Microsoft Open Source Code of Conduct][02] | ||
- [Microsoft Code of Conduct FAQ][03] | ||
- Contact [opencode@microsoft.com][04] with questions or concerns | ||
- Employees can reach out at [aka.ms/opensource/moderation-support][01] | ||
|
||
<!-- link references --> | ||
[01]: https://aka.ms/opensource/moderation-support | ||
[02]: https://opensource.microsoft.com/codeofconduct/ | ||
[03]: https://opensource.microsoft.com/codeofconduct/faq/ | ||
[04]: mailto:opencode@microsoft.com |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,58 @@ | ||
# Contributor Guide | ||
|
||
Thank you for your interest in contributing to quality documentations. As an open source project, we | ||
welcome input and updates from the community. | ||
|
||
The process for contributing to this project is documented in our | ||
[Contributor's Guide](https://aka.ms/PSDocsContributor). | ||
|
||
## PowerShell-Docs-Modules structure | ||
|
||
There are three categories of content in this repository: | ||
|
||
- reference content | ||
- conceptual content | ||
- metadata and configuration files | ||
|
||
We only maintain documentation for the current release of these modules. | ||
|
||
### Reference content | ||
|
||
The reference content is the PowerShell cmdlet reference for the DSC cmdlets. The cmdlet reference | ||
for the various modules is collected in the `reference/ps-modules` folder. This content is also used | ||
to create the help information displayed by the `Get-Help` cmdlet. | ||
|
||
### Conceptual content | ||
|
||
The conceptual documentation is also organized by module or product. | ||
|
||
> [!NOTE] | ||
> Anytime a conceptual article is added, removed, or renamed, the TOC must be updated and deleted or | ||
> renamed files must be redirected. | ||
### Metadata files | ||
|
||
This project contains several types of metadata files. The metadata files control the behavior of | ||
our build tools and the publishing system. Only PowerShell-Docs maintainers and approved | ||
contributors are allowed to change these files. If you think that a meta file should be changed, | ||
open an issue to discuss the needed changes. | ||
|
||
Meta files in the root of the repository | ||
|
||
- `.*` - configuration files in the root of the repository | ||
- `*.md` - Project documentation in the root of the repository | ||
- `*.yml` - build automation files | ||
- `.devcontainer/*` - devcontainer configuration files | ||
- `.github/**/*` - GitHub templates, actions, and other meta files | ||
- `.vscode/**/*` - VS Code extension configurations | ||
- `breadcrumb/*` - breadcrumb navigation configuration | ||
|
||
Meta files in the documentation set | ||
|
||
- `reference/**/*.json` - docset configuration files | ||
- `reference/**/*.yml` - TOC and other structured content files | ||
- `reference/**/*.ps1` - Example DSC resources and configurations | ||
- `reference/breadcrumb/*` - breadcrumb navigation configuration | ||
- `reference/includes/*` - markdown include files | ||
- `reference/mapping/*` - version mapping configuration | ||
- `reference/**/media/**` - image files used in documentation |
Oops, something went wrong.