Skip to content

Commit 3184977

Browse files
chrisdachrisda
authored
Merge branch 'main' into patch-25
2 parents 0222e13 + 28bbd32 commit 3184977

File tree

4,633 files changed

+898610
-29485
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

4,633 files changed

+898610
-29485
lines changed

‎.devcontainer/Dockerfile

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
FROM mcr.microsoft.com/devcontainers/base:ubuntu
2+
RUN wget https://github.com/errata-ai/vale/releases/download/v2.26.0/vale_2.26.0_Linux_64-bit.tar.gz && \
3+
tar -xvzf vale_2.26.0_Linux_64-bit.tar.gz -C bin && \
4+
export PATH=./bin:"$PATH"

‎.devcontainer/devcontainer.json

+42
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
{
2+
"build": {
3+
"dockerfile": "Dockerfile"
4+
},
5+
"features": {
6+
"ghcr.io/devcontainers/features/git:1": {},
7+
"ghcr.io/devcontainers/features/github-cli:1": {},
8+
"ghcr.io/devcontainers/features/powershell:1": {
9+
"modules": "Documentarian,Documentarian.Vale,Documentarian.MicrosoftDocs,Documentarian.ModuleAuthor"
10+
}
11+
},
12+
"customizations": {
13+
"vscode": {
14+
"extensions": [
15+
"chrischinchilla.vale-vscode",
16+
"davidanson.vscode-markdownlint",
17+
"docsmsft.docs-images",
18+
"docsmsft.docs-linting",
19+
"docsmsft.docs-markdown",
20+
"docsmsft.docs-preview",
21+
"docsmsft.docs-yaml",
22+
"eamodio.gitlens",
23+
"marvhen.reflow-markdown",
24+
"ms-vscode.powershell",
25+
"ms-vscode.wordcount",
26+
"nhoizey.gremlins",
27+
"redhat.vscode-yaml",
28+
"shuworks.vscode-table-formatter",
29+
"streetsidesoftware.code-spell-checker",
30+
"tyriar.sort-lines",
31+
"usernamehw.errorlens",
32+
"wmaurer.change-case"
33+
],
34+
"settings": {
35+
"terminal.integrated.defaultProfile.linux": "pwsh",
36+
"vale.valeCLI.path": "",
37+
"vale.valeCLI.config": ""
38+
}
39+
}
40+
},
41+
"postStartCommand": "vale sync"
42+
}

‎.gitattributes

+3
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,9 @@
99
# Declare files that will always have CRLF line endings on checkout.
1010
*.sln text eol=crlf
1111

12+
# Ensure devcontainer files are always LF
13+
.devcontainer/** eol=lf
14+
1215
# Denote all files that are truly binary and should not be modified.
1316
*.png binary
1417
*.jpg binary

‎.github/ISSUE_TEMPLATE/00-bug.yml

+76
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
name: "🐛 Report a documentation issue"
2+
description: >-
3+
Report an issue with current documentation.
4+
labels:
5+
- issue-doc-bug
6+
- needs-triage
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: >-
11+
Use this template to report issues with documentation. This can include typos, technical and
12+
factual errors, grammar, spelling, formatting, presentation, etc.
13+
- type: checkboxes
14+
id: prerequisites
15+
attributes:
16+
label: Prerequisites
17+
description: >-
18+
These steps are required. After you've completed each step, check the box for it before
19+
moving on.
20+
options:
21+
- label: >-
22+
**Existing Issue:** Search the existing issues for this repository. If there is an issue
23+
that fits your needs do not file a new one. Subscribe, react, or comment on that issue
24+
instead.
25+
required: true
26+
- label: >-
27+
**Descriptive Title:** Write the title for this issue as a short synopsis. If possible,
28+
provide context. For example, "Typo in `Get-Foo` cmdlet" instead of "Typo."
29+
required: true
30+
- label: >-
31+
**Verify Version:** If there is a mismatch between documentation and the behavior on
32+
your system, ensure that the version you are using is the same as the documentation.
33+
Check this box if they match or the issue you are reporting is not version specific.
34+
required: true
35+
- type: textarea
36+
id: link_list
37+
validations:
38+
required: true
39+
attributes:
40+
label: Links
41+
description: >-
42+
Provide a list of links to the documentation page(s) that show the problem you are
43+
reporting. Use the markdown list syntax for each item. If you are linking to the source for
44+
the document, please use the permalink to the lines that show the problem. If you are
45+
linking to the live page for the document, please ensure each link is to the nearest header
46+
anchor to the problem instead of the page itself.
47+
placeholder: |
48+
- https://github.com/MicrosoftDocs/windows-powershell-docs/blob/6f930d26c45d3bfba56d82b23785da1218bfad2a/docset/docs-conceptual/winserver2022-ps/module-compatibility.md?plain=1#L21-L23
49+
- https://learn.microsoft.com/powershell/windows/module-compatibility#windows-management-modules
50+
- type: textarea
51+
id: summary
52+
validations:
53+
required: true
54+
attributes:
55+
label: Summary
56+
description: >-
57+
Write a clear and concise description of the problem.
58+
- type: textarea
59+
id: details
60+
validations:
61+
required: false
62+
attributes:
63+
label: Details
64+
description: >-
65+
If possible, please provide extended details that will add context and help the team update
66+
the documentation. Additional details may not be useful for typos, grammar, formatting, etc.
67+
For technical or factual errors, please include code snippets and output to show how the
68+
documentation is incorrect.
69+
- type: textarea
70+
id: suggestion
71+
validations:
72+
required: false
73+
attributes:
74+
label: Suggested Fix
75+
description: >-
76+
If you have an idea for how to fix the problem you're identifying, include it here.

‎.github/ISSUE_TEMPLATE/00-hacktoberfest.yml

-78
This file was deleted.

‎.github/ISSUE_TEMPLATE/01-article.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
name: "💡 New Document Request/Idea"
1+
name: "💡 Suggest a new document or idea"
22
description: >-
33
Suggest a new document or major rewrite of an existing one.
44
labels:
5-
- doc-idea
5+
- issue-doc-idea
66
- needs-triage
77
body:
88
- type: checkboxes

‎.github/ISSUE_TEMPLATE/02-bug.yml

-76
This file was deleted.

‎.github/ISSUE_TEMPLATE/02-quality.yml

+87
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
name: "🦾 Commit to a Quality Contribution"
2+
description: >-
3+
File an issue to take part in the PowerShell Docs Quality Contributions project.
4+
labels:
5+
- project-quality
6+
title: "Quality: "
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
This issue template is for the [PowerShell Docs Quality Contributions project][a1].
12+
13+
For more more info, see [Contributing quality improvements][a2] in our Contributor's Guide.
14+
15+
[a1]: https://github.com/orgs/MicrosoftDocs/projects/15
16+
[a2]: https://learn.microsoft.com/powershell/scripting/community/contributing/quality-improvements
17+
- type: checkboxes
18+
id: prerequisites
19+
attributes:
20+
label: Prerequisites
21+
description: >-
22+
These steps are required. After you've completed each step, check the box for it before
23+
moving on.
24+
options:
25+
- label: |
26+
**Existing Issue:**
27+
28+
Search the existing [quality issues][b1] for this repository. If there's an issue that
29+
covers the quality area and articles you want to improve, pick a different quality area
30+
or article set. Don't file a new issue for the same work. Subscribe, react, or comment
31+
on that issue instead.
32+
33+
[b1]: https://github.com/orgs/MicrosoftDocs/projects/15/views/4
34+
required: true
35+
- label: |
36+
**Descriptive Title:**
37+
38+
Write the title for this issue as a short synopsis. If possible, provide context. For
39+
example, "Quality: Command Syntax in Foo" instead of "Quality: Foo"
40+
required: true
41+
- type: dropdown
42+
id: QualityArea
43+
validations:
44+
required: true
45+
attributes:
46+
label: Quality Areas
47+
description: |
48+
Select one or more quality areas to improve on with your contribution.
49+
50+
For more information, see the relevant section in the meta issue:
51+
52+
- [Aliases][c1]: Ensure cmdlet aliases are documented
53+
- [Formatting code samples][c2]: Ensure proper casing, line length, etc in code samples
54+
- [Formatting command syntax][c3]: Ensure proper casing and formatting for command syntax, including cmdlets, types, etc.
55+
- [Link References][c4]: Ensure links in conceptual docs are defined as numbered references
56+
- [Markdown linting][c5]: Ensure content follows markdownlint rules
57+
- [Spelling][c6]: Ensure proper casing and spelling for words
58+
59+
[c1]: https://learn.microsoft.com/powershell/scripting/community/contributing/quality-improvements#aliases
60+
[c2]: https://learn.microsoft.com/powershell/scripting/community/contributing/quality-improvements#formatting-code-samples
61+
[c3]: https://learn.microsoft.com/powershell/scripting/community/contributing/quality-improvements#formatting-command-syntax
62+
[c4]: https://learn.microsoft.com/powershell/scripting/community/contributing/quality-improvements#link-references
63+
[c5]: https://learn.microsoft.com/powershell/scripting/community/contributing/quality-improvements#markdown-linting
64+
[c6]: https://learn.microsoft.com/powershell/scripting/community/contributing/quality-improvements#spelling
65+
multiple: true
66+
options:
67+
- Aliases
68+
- Formatting code samples
69+
- Formatting command syntax
70+
- Link References
71+
- Markdown linting
72+
- Spelling
73+
- type: textarea
74+
id: ArticleList
75+
validations:
76+
required: true
77+
attributes:
78+
label: Article List
79+
description: >-
80+
Specify the articles you are committing to work on, one per line. You can specify each entry
81+
as a path, the article's title, or the link to the article on Learn. If you specify an
82+
article by path for a reference article, such as a cmdlet or about topic, specify the
83+
version segment as `*.*`.
84+
placeholder: |
85+
- reference/*.*/Microsoft.PowerShell.Core/Add-History.md
86+
- Add-History
87+
- https://learn.microsoft.com/powershell/module/microsoft.powershell.core/add-history

0 commit comments

Comments
 (0)