Skip to content

Commit 7b6c912

Browse files
denisebmsftdenisebmsft
authored
Merge branch 'main' into patch-2
2 parents 4d7d410 + 509e45a commit 7b6c912

File tree

187 files changed

+8646
-4007
lines changed

Some content is hidden

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

187 files changed

+8646
-4007
lines changed

‎.github/ISSUE_TEMPLATE/00-bug.yml

Lines changed: 76 additions & 0 deletions
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+
- 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/01-article.yml

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
name: "💡 Suggest a new document or idea"
2+
description: >-
3+
Suggest a new document or major rewrite of an existing one.
4+
labels:
5+
- doc-idea
6+
- needs-triage
7+
body:
8+
- type: checkboxes
9+
id: prerequisites
10+
attributes:
11+
label: Prerequisites
12+
description: >-
13+
These steps are required. After you've completed each step, check the box for it before
14+
moving on.
15+
options:
16+
- label: >-
17+
**Existing Issue:** Search the existing issues for this repository. If there is an issue
18+
that fits your needs do not file a new one. Subscribe, react, or comment on that issue
19+
instead.
20+
required: true
21+
- label: >-
22+
**Descriptive Title:** Write the title for this issue as a short synopsis. If possible,
23+
provide context. For example, "Document new `Get-Foo` cmdlet" instead of "New cmdlet."
24+
required: true
25+
# Commented out for now - Need to think about how to do versioning/module picking
26+
# - type: dropdown
27+
# id: version
28+
# validations:
29+
# required: true
30+
# attributes:
31+
# label: PowerShell Version
32+
# description: >-
33+
# Select the version or versions of the PowerShell this documentation is for.
34+
# multiple: true
35+
# options:
36+
# - "5.1"
37+
# - "7.0"
38+
# - "7.2"
39+
# - "7.3"
40+
- type: textarea
41+
id: summary
42+
validations:
43+
required: true
44+
attributes:
45+
label: Summary
46+
description: >-
47+
Write a clear and concise description of the proposed document. Why is it needed? What gap
48+
will it fill? Who is the intended audience? What scenarios will it address?
49+
placeholder: |
50+
Try formulating the need for this documentation as a user story.
51+
52+
> As a user of <module>, I need a document about <topic> so that <synopsis of value>.
53+
- type: textarea
54+
id: details
55+
validations:
56+
required: false
57+
attributes:
58+
label: Details
59+
description: >-
60+
If possible, please provide extended details that will add context and help the team write
61+
the documentation.
62+
- type: dropdown
63+
id: type
64+
validations:
65+
required: true
66+
attributes:
67+
label: Proposed Content Type
68+
description: >-
69+
Choose the type or types of documentation required.
70+
multiple: true
71+
options:
72+
- Cmdlet Reference
73+
- About Topic
74+
- Concept
75+
- Other / Unknown
76+
- type: input
77+
id: title
78+
validations:
79+
required: false
80+
attributes:
81+
label: Proposed Title
82+
- type: textarea
83+
id: related_documents
84+
validations:
85+
required: false
86+
attributes:
87+
label: Related Articles
88+
description: >-
89+
Provide a list of links to the documentation page(s) that are related to this request. Use
90+
the markdown list syntax for each item. If the entire article is relevant, just link to the
91+
permalink for its source or the live page. If only a section of the article is relevant, use
92+
the permalink to the lines for the most relevant section of the source or the anchor link to
93+
the nearest header for the relevant content instead of the page itself.
94+
placeholder: |
95+
- https://github.com/MicrosoftDocs/windows-powershell-docs/blob/6f930d26c45d3bfba56d82b23785da1218bfad2a/docset/docs-conceptual/winserver2022-ps/module-compatibility.md?plain=1#L21-L23
96+
- https://learn.microsoft.com/powershell/windows/module-compatibility#windows-management-modules

‎.github/ISSUE_TEMPLATE/02-quality.yml

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

‎.github/ISSUE_TEMPLATE/config.yml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: What's the Quality Contributions Project?
4+
url: https://learn.microsoft.com/powershell/scripting/community/contributing/quality-improvements
5+
about: >-
6+
If you'd like to commit to improving quality for the documentation, before filing an issue,
7+
check the info and instructions.
8+
# - name: PowerShell Product Feedback
9+
# url: https://github.com/PowerShell/PowerShell/issues/new/choose
10+
# about: Please open feature requests for current PowerShell here.
11+
# - name: Support
12+
# url: https://learn.microsoft.com/powershell/scripting/community/community-support
13+
# about: PowerShell Support Questions/Help

‎.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# PR Summary
2+
3+
<!--
4+
Delete this comment block and summarize your changes and list
5+
related issues here. For example:
6+
7+
This changes fixes problem X in the documentation for Y.
8+
9+
- Fixes #1234
10+
- Resolves #1235
11+
-->
12+
13+
## PR Checklist
14+
15+
<!--
16+
These items are mandatory. For your PR to be reviewed and merged,
17+
ensure you have followed these steps. As you complete the steps,
18+
check each box by replacing the space between the brackets with an
19+
x or by clicking on the box in the UI after your PR is submitted.
20+
-->
21+
22+
- [ ] **Descriptive Title:** This PR's title is a synopsis of the changes it proposes.
23+
- [ ] **Summary:** This PR's summary describes the scope and intent of the change.
24+
- [ ] **Contributor's Guide:** I have read the [contributors guide][contrib].
25+
- [ ] **Style:** This PR adheres to the [style guide][style].
26+
27+
<!--
28+
If your PR is a work in progress, please mark it as a draft or
29+
prefix it with "(WIP)" or "WIP:"
30+
31+
This helps us understand whether or not your PR is ready to review.
32+
-->
33+
34+
[contrib]: https://learn.microsoft.com/powershell/scripting/community/contributing/overview
35+
[style]: https://learn.microsoft.com/powershell/scripting/community/contributing/powershell-style-guide

‎.github/dependabot.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
version: 2
2+
updates:
3+
- package-ecosystem: "github-actions"
4+
directory: "/"
5+
schedule:
6+
interval: "weekly"

‎.github/workflows/checklist.yml

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
name: Checklist
2+
on:
3+
pull_request:
4+
branches:
5+
- main
6+
types:
7+
- opened
8+
- reopened
9+
- ready_for_review
10+
- edited
11+
- synchronize
12+
permissions:
13+
contents: read
14+
jobs:
15+
Test:
16+
name: Verify Status
17+
runs-on: windows-latest
18+
if: |
19+
!contains(github.event.pull_request.title, 'WIP') &&
20+
!github.event.pull_request.draft
21+
defaults:
22+
run:
23+
shell: pwsh
24+
steps:
25+
- name: Verify Checklist
26+
id: verify_checklist
27+
uses: MicrosoftDocs/PowerShell-Docs/.github/actions/verification/checklist/v1@main

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy