-
Notifications
You must be signed in to change notification settings - Fork 603
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
15,066 changed files
with
52,724 additions
and
31,187 deletions.
The diff you're trying to view is too large. We only load the first 3000 changed files.
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
FROM mcr.microsoft.com/devcontainers/base:ubuntu | ||
RUN wget https://github.com/errata-ai/vale/releases/download/v2.26.0/vale_2.26.0_Linux_64-bit.tar.gz && \ | ||
tar -xvzf vale_2.26.0_Linux_64-bit.tar.gz -C bin && \ | ||
export PATH=./bin:"$PATH" |
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,42 @@ | ||
{ | ||
"build": { | ||
"dockerfile": "Dockerfile" | ||
}, | ||
"features": { | ||
"ghcr.io/devcontainers/features/git:1": {}, | ||
"ghcr.io/devcontainers/features/github-cli:1": {}, | ||
"ghcr.io/devcontainers/features/powershell:1": { | ||
"modules": "Documentarian,Documentarian.Vale,Documentarian.MicrosoftDocs,Documentarian.ModuleAuthor" | ||
} | ||
}, | ||
"customizations": { | ||
"vscode": { | ||
"extensions": [ | ||
"chrischinchilla.vale-vscode", | ||
"davidanson.vscode-markdownlint", | ||
"docsmsft.docs-images", | ||
"docsmsft.docs-linting", | ||
"docsmsft.docs-markdown", | ||
"docsmsft.docs-preview", | ||
"docsmsft.docs-yaml", | ||
"eamodio.gitlens", | ||
"marvhen.reflow-markdown", | ||
"ms-vscode.powershell", | ||
"ms-vscode.wordcount", | ||
"nhoizey.gremlins", | ||
"redhat.vscode-yaml", | ||
"shuworks.vscode-table-formatter", | ||
"streetsidesoftware.code-spell-checker", | ||
"tyriar.sort-lines", | ||
"usernamehw.errorlens", | ||
"wmaurer.change-case" | ||
], | ||
"settings": { | ||
"terminal.integrated.defaultProfile.linux": "pwsh", | ||
"vale.valeCLI.path": "", | ||
"vale.valeCLI.config": "" | ||
} | ||
} | ||
}, | ||
"postStartCommand": "vale sync" | ||
} |
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 |
---|---|---|
@@ -0,0 +1,76 @@ | ||
name: "🐛 Report a documentation issue" | ||
description: >- | ||
Report an issue with current documentation. | ||
labels: | ||
- issue-doc-bug | ||
- needs-triage | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: >- | ||
Use this template to report issues with documentation. This can include typos, technical and | ||
factual errors, grammar, spelling, formatting, presentation, etc. | ||
- type: checkboxes | ||
id: prerequisites | ||
attributes: | ||
label: Prerequisites | ||
description: >- | ||
These steps are required. After you've completed each step, check the box for it before | ||
moving on. | ||
options: | ||
- label: >- | ||
**Existing Issue:** Search the existing issues for this repository. If there is an issue | ||
that fits your needs do not file a new one. Subscribe, react, or comment on that issue | ||
instead. | ||
required: true | ||
- label: >- | ||
**Descriptive Title:** Write the title for this issue as a short synopsis. If possible, | ||
provide context. For example, "Typo in `Get-Foo` cmdlet" instead of "Typo." | ||
required: true | ||
- label: >- | ||
**Verify Version:** If there is a mismatch between documentation and the behavior on | ||
your system, ensure that the version you are using is the same as the documentation. | ||
Check this box if they match or the issue you are reporting is not version specific. | ||
required: true | ||
- type: textarea | ||
id: link_list | ||
validations: | ||
required: true | ||
attributes: | ||
label: Links | ||
description: >- | ||
Provide a list of links to the documentation page(s) that show the problem you are | ||
reporting. Use the markdown list syntax for each item. If you are linking to the source for | ||
the document, please use the permalink to the lines that show the problem. If you are | ||
linking to the live page for the document, please ensure each link is to the nearest header | ||
anchor to the problem instead of the page itself. | ||
placeholder: | | ||
- https://github.com/MicrosoftDocs/windows-powershell-docs/blob/6f930d26c45d3bfba56d82b23785da1218bfad2a/docset/docs-conceptual/winserver2022-ps/module-compatibility.md?plain=1#L21-L23 | ||
- https://learn.microsoft.com/powershell/windows/module-compatibility#windows-management-modules | ||
- type: textarea | ||
id: summary | ||
validations: | ||
required: true | ||
attributes: | ||
label: Summary | ||
description: >- | ||
Write a clear and concise description of the problem. | ||
- type: textarea | ||
id: details | ||
validations: | ||
required: false | ||
attributes: | ||
label: Details | ||
description: >- | ||
If possible, please provide extended details that will add context and help the team update | ||
the documentation. Additional details may not be useful for typos, grammar, formatting, etc. | ||
For technical or factual errors, please include code snippets and output to show how the | ||
documentation is incorrect. | ||
- type: textarea | ||
id: suggestion | ||
validations: | ||
required: false | ||
attributes: | ||
label: Suggested Fix | ||
description: >- | ||
If you have an idea for how to fix the problem you're identifying, include it here. |
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,96 @@ | ||
name: "💡 Suggest a new document or idea" | ||
description: >- | ||
Suggest a new document or major rewrite of an existing one. | ||
labels: | ||
- issue-doc-idea | ||
- needs-triage | ||
body: | ||
- type: checkboxes | ||
id: prerequisites | ||
attributes: | ||
label: Prerequisites | ||
description: >- | ||
These steps are required. After you've completed each step, check the box for it before | ||
moving on. | ||
options: | ||
- label: >- | ||
**Existing Issue:** Search the existing issues for this repository. If there is an issue | ||
that fits your needs do not file a new one. Subscribe, react, or comment on that issue | ||
instead. | ||
required: true | ||
- label: >- | ||
**Descriptive Title:** Write the title for this issue as a short synopsis. If possible, | ||
provide context. For example, "Document new `Get-Foo` cmdlet" instead of "New cmdlet." | ||
required: true | ||
# Commented out for now - Need to think about how to do versioning/module picking | ||
# - type: dropdown | ||
# id: version | ||
# validations: | ||
# required: true | ||
# attributes: | ||
# label: PowerShell Version | ||
# description: >- | ||
# Select the version or versions of the PowerShell this documentation is for. | ||
# multiple: true | ||
# options: | ||
# - "5.1" | ||
# - "7.0" | ||
# - "7.2" | ||
# - "7.3" | ||
- type: textarea | ||
id: summary | ||
validations: | ||
required: true | ||
attributes: | ||
label: Summary | ||
description: >- | ||
Write a clear and concise description of the proposed document. Why is it needed? What gap | ||
will it fill? Who is the intended audience? What scenarios will it address? | ||
placeholder: | | ||
Try formulating the need for this documentation as a user story. | ||
> As a user of <module>, I need a document about <topic> so that <synopsis of value>. | ||
- type: textarea | ||
id: details | ||
validations: | ||
required: false | ||
attributes: | ||
label: Details | ||
description: >- | ||
If possible, please provide extended details that will add context and help the team write | ||
the documentation. | ||
- type: dropdown | ||
id: type | ||
validations: | ||
required: true | ||
attributes: | ||
label: Proposed Content Type | ||
description: >- | ||
Choose the type or types of documentation required. | ||
multiple: true | ||
options: | ||
- Cmdlet Reference | ||
- About Topic | ||
- Concept | ||
- Other / Unknown | ||
- type: input | ||
id: title | ||
validations: | ||
required: false | ||
attributes: | ||
label: Proposed Title | ||
- type: textarea | ||
id: related_documents | ||
validations: | ||
required: false | ||
attributes: | ||
label: Related Articles | ||
description: >- | ||
Provide a list of links to the documentation page(s) that are related to this request. Use | ||
the markdown list syntax for each item. If the entire article is relevant, just link to the | ||
permalink for its source or the live page. If only a section of the article is relevant, use | ||
the permalink to the lines for the most relevant section of the source or the anchor link to | ||
the nearest header for the relevant content instead of the page itself. | ||
placeholder: | | ||
- https://github.com/MicrosoftDocs/windows-powershell-docs/blob/6f930d26c45d3bfba56d82b23785da1218bfad2a/docset/docs-conceptual/winserver2022-ps/module-compatibility.md?plain=1#L21-L23 | ||
- https://learn.microsoft.com/powershell/windows/module-compatibility#windows-management-modules |
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,87 @@ | ||
name: "🦾 Commit to a Quality Contribution" | ||
description: >- | ||
File an issue to take part in the PowerShell Docs Quality Contributions project. | ||
labels: | ||
- project-quality | ||
title: "Quality: " | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
This issue template is for the [PowerShell Docs Quality Contributions project][a1]. | ||
For more more info, see [Contributing quality improvements][a2] in our Contributor's Guide. | ||
[a1]: https://github.com/orgs/MicrosoftDocs/projects/15 | ||
[a2]: https://learn.microsoft.com/powershell/scripting/community/contributing/quality-improvements | ||
- type: checkboxes | ||
id: prerequisites | ||
attributes: | ||
label: Prerequisites | ||
description: >- | ||
These steps are required. After you've completed each step, check the box for it before | ||
moving on. | ||
options: | ||
- label: | | ||
**Existing Issue:** | ||
Search the existing [quality issues][b1] for this repository. If there's an issue that | ||
covers the quality area and articles you want to improve, pick a different quality area | ||
or article set. Don't file a new issue for the same work. Subscribe, react, or comment | ||
on that issue instead. | ||
[b1]: https://github.com/orgs/MicrosoftDocs/projects/15/views/4 | ||
required: true | ||
- label: | | ||
**Descriptive Title:** | ||
Write the title for this issue as a short synopsis. If possible, provide context. For | ||
example, "Quality: Command Syntax in Foo" instead of "Quality: Foo" | ||
required: true | ||
- type: dropdown | ||
id: QualityArea | ||
validations: | ||
required: true | ||
attributes: | ||
label: Quality Areas | ||
description: | | ||
Select one or more quality areas to improve on with your contribution. | ||
For more information, see the relevant section in the meta issue: | ||
- [Aliases][c1]: Ensure cmdlet aliases are documented | ||
- [Formatting code samples][c2]: Ensure proper casing, line length, etc in code samples | ||
- [Formatting command syntax][c3]: Ensure proper casing and formatting for command syntax, including cmdlets, types, etc. | ||
- [Link References][c4]: Ensure links in conceptual docs are defined as numbered references | ||
- [Markdown linting][c5]: Ensure content follows markdownlint rules | ||
- [Spelling][c6]: Ensure proper casing and spelling for words | ||
[c1]: https://learn.microsoft.com/powershell/scripting/community/contributing/quality-improvements#aliases | ||
[c2]: https://learn.microsoft.com/powershell/scripting/community/contributing/quality-improvements#formatting-code-samples | ||
[c3]: https://learn.microsoft.com/powershell/scripting/community/contributing/quality-improvements#formatting-command-syntax | ||
[c4]: https://learn.microsoft.com/powershell/scripting/community/contributing/quality-improvements#link-references | ||
[c5]: https://learn.microsoft.com/powershell/scripting/community/contributing/quality-improvements#markdown-linting | ||
[c6]: https://learn.microsoft.com/powershell/scripting/community/contributing/quality-improvements#spelling | ||
multiple: true | ||
options: | ||
- Aliases | ||
- Formatting code samples | ||
- Formatting command syntax | ||
- Link References | ||
- Markdown linting | ||
- Spelling | ||
- type: textarea | ||
id: ArticleList | ||
validations: | ||
required: true | ||
attributes: | ||
label: Article List | ||
description: >- | ||
Specify the articles you are committing to work on, one per line. You can specify each entry | ||
as a path, the article's title, or the link to the article on Learn. If you specify an | ||
article by path for a reference article, such as a cmdlet or about topic, specify the | ||
version segment as `*.*`. | ||
placeholder: | | ||
- reference/*.*/Microsoft.PowerShell.Core/Add-History.md | ||
- Add-History | ||
- https://learn.microsoft.com/powershell/module/microsoft.powershell.core/add-history |
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,13 @@ | ||
blank_issues_enabled: true | ||
contact_links: | ||
- name: What's the Quality Contributions Project? | ||
url: https://learn.microsoft.com/powershell/scripting/community/contributing/quality-improvements | ||
about: >- | ||
If you'd like to commit to improving quality for the documentation, before filing an issue, | ||
check the info and instructions. | ||
# - name: PowerShell Product Feedback | ||
# url: https://github.com/PowerShell/PowerShell/issues/new/choose | ||
# about: Please open feature requests for current PowerShell here. | ||
# - name: Support | ||
# url: https://learn.microsoft.com/powershell/scripting/community/community-support | ||
# about: PowerShell Support Questions/Help |
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,35 @@ | ||
# PR Summary | ||
|
||
<!-- | ||
Delete this comment block and summarize your changes and list | ||
related issues here. For example: | ||
This changes fixes problem X in the documentation for Y. | ||
- Fixes #1234 | ||
- Resolves #1235 | ||
--> | ||
|
||
## PR Checklist | ||
|
||
<!-- | ||
These items are mandatory. For your PR to be reviewed and merged, | ||
ensure you have followed these steps. As you complete the steps, | ||
check each box by replacing the space between the brackets with an | ||
x or by clicking on the box in the UI after your PR is submitted. | ||
--> | ||
|
||
- [ ] **Descriptive Title:** This PR's title is a synopsis of the changes it proposes. | ||
- [ ] **Summary:** This PR's summary describes the scope and intent of the change. | ||
- [ ] **Contributor's Guide:** I have read the [contributors guide][contrib]. | ||
- [ ] **Style:** This PR adheres to the [style guide][style]. | ||
|
||
<!-- | ||
If your PR is a work in progress, please mark it as a draft or | ||
prefix it with "(WIP)" or "WIP:" | ||
This helps us understand whether or not your PR is ready to review. | ||
--> | ||
|
||
[contrib]: https://learn.microsoft.com/powershell/scripting/community/contributing/overview | ||
[style]: https://learn.microsoft.com/powershell/scripting/community/contributing/powershell-style-guide |
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,6 @@ | ||
version: 2 | ||
updates: | ||
- package-ecosystem: "github-actions" | ||
directory: "/" | ||
schedule: | ||
interval: "weekly" |
Oops, something went wrong.