Skip to content

Commit

Permalink
Update meta files (#273)
Browse files Browse the repository at this point in the history
* Update meta files

* Update description for .yml files in CONTRIBUTING.md
  • Loading branch information
sdwheeler authored Jan 3, 2025
1 parent 8bcb6cb commit 3ff6ede
Show file tree
Hide file tree
Showing 8 changed files with 527 additions and 443 deletions.
46 changes: 40 additions & 6 deletions CODE_OF_CONDUCT.md
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 [[email protected]](mailto:[email protected]) 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 [[email protected]][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:[email protected]
55 changes: 55 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
# 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-DSC structure

There are three categories of content in this repository:

- reference content
- conceptual content
- metadata and configuration files

### Reference content

The reference content is the PowerShell cmdlet reference for the DSC cmdlets. The cmdlet reference
is collected in versioned folders (like dsc-1.1, dsc-2.0, and dsc-3.0). 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 version.

> [!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

Meta files in the documentation set

- `dsc/**/*.json` - docset configuration files
- `dsc/**/*.yml` - TOC and other structured content files
- `dsc/**/*.ps1` - Example DSC resources and configurations
- `dsc/breadcrumb/*` - breadcrumb navigation configuration
- `dsc/includes/*` - markdown include files
- `dsc/mapping/*` - version mapping configuration
- `dsc/**/media/**` - image files used in documentation
Loading

0 comments on commit 3ff6ede

Please sign in to comment.