Skip to content

Commit 2a49238

Browse files
tiburdtiburd
authored
Merge branch 'main' into patch-1
2 parents 330c316 + f34606c commit 2a49238

File tree

464 files changed

+26276
-13502
lines changed

Some content is hidden

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

464 files changed

+26276
-13502
lines changed

‎.devcontainer/Dockerfile

Lines changed: 4 additions & 0 deletions
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

Lines changed: 42 additions & 0 deletions
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

Lines changed: 3 additions & 0 deletions
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/02-bug.yml renamed to ‎.github/ISSUE_TEMPLATE/00-bug.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
name: "🐛 Report Documentation issue"
1+
name: "🐛 Report a documentation issue"
22
description: >-
33
Report an issue with current documentation.
44
labels:
5-
- doc-bug
5+
- issue-doc-bug
66
- needs-triage
77
body:
88
- type: markdown

‎.github/ISSUE_TEMPLATE/00-hacktoberfest.yml

Lines changed: 0 additions & 78 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/01-article.yml

Lines changed: 2 additions & 2 deletions
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-quality.yml

Lines changed: 87 additions & 0 deletions
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

‎.github/ISSUE_TEMPLATE/config.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
blank_issues_enabled: true
22
contact_links:
3-
- name: 🎃 Hacktoberfest 2022
4-
url: https://github.com/MicrosoftDocs/PowerShell-Docs/issues/9257
3+
- name: What's the Quality Contributions Project?
4+
url: https://learn.microsoft.com/powershell/scripting/community/contributing/quality-improvements
55
about: >-
6-
If you'd like to participate in Hacktoberfest 2022, before filing an issue, check the info
7-
and instructions.
6+
If you'd like to commit to improving quality for the documentation, before filing an issue,
7+
check the info and instructions.
88
# - name: PowerShell Product Feedback
99
# url: https://github.com/PowerShell/PowerShell/issues/new/choose
1010
# about: Please open feature requests for current PowerShell here.

‎.github/workflows/quality.issue.yml

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
name: "Quality Contribution Issues"
2+
on:
3+
issues:
4+
types:
5+
- opened
6+
7+
jobs:
8+
# Check if the issue is for quality contributions; all other jobs depend on this one.
9+
quality:
10+
name: Is Quality Contribution?
11+
runs-on: ubuntu-latest
12+
outputs:
13+
check: ${{ steps.is-quality.outputs.match != '' }}
14+
steps:
15+
- uses: actions-ecosystem/action-regex-match@v2
16+
id: is-quality
17+
with:
18+
text: ${{ github.event.issue.body }}
19+
regex: "Quality: Foo"
20+
flags: gm
21+
22+
assign:
23+
name: Assign to author
24+
needs: quality
25+
if: needs.quality.outputs.check == 'true'
26+
runs-on: ubuntu-latest
27+
steps:
28+
- uses: actions-ecosystem/action-add-assignees@v1
29+
with:
30+
github_token: ${{ secrets.github_token }}
31+
assignees: ${{ github.event.issue.user.login }}
32+
33+
label:
34+
name: Add quality labels
35+
needs: quality
36+
if: needs.quality.outputs.check == 'true'
37+
runs-on: ubuntu-latest
38+
strategy:
39+
fail-fast: false
40+
matrix:
41+
include:
42+
- regex: Aliases
43+
label: quality-aliases
44+
- regex: Formatting code samples
45+
label: quality-format-code-samples
46+
- regex: Formatting command syntax
47+
label: quality-format-command-syntax
48+
- regex: Link references
49+
label: quality-link-references
50+
- regex: Markdown linting
51+
label: quality-markdownlint
52+
- regex: Spelling
53+
label: quality-spelling
54+
steps:
55+
- uses: actions-ecosystem/action-regex-match@v2
56+
id: matcher
57+
with:
58+
text: ${{ github.event.issue.body }}
59+
regex: '^### Quality Areas\s*^.*${{ matrix.regex }}.*$'
60+
flags: gm
61+
- uses: actions-ecosystem/action-add-labels@v1
62+
if: steps.matcher.outputs.match != ''
63+
with:
64+
labels: ${{ matrix.label }}

‎.github/workflows/quality.pr.yml

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
name: "Quality Contributions"
2+
on:
3+
pull_request_target:
4+
branches:
5+
- main
6+
types:
7+
- opened
8+
- reopened
9+
- edited
10+
11+
defaults:
12+
run:
13+
shell: pwsh
14+
15+
jobs:
16+
# Check if the PR is for quality contributions; all other jobs depend on this one.
17+
check:
18+
name: Is Quality Contribution?
19+
outputs:
20+
title: ${{ steps.title.outputs.check == 'true' }}
21+
runs-on: ubuntu-latest
22+
steps:
23+
- id: title
24+
run: |
25+
$Check = "${{ contains(github.event.pull_request.title, 'Quality:') }}"
26+
"Check: $Check"
27+
"check=$Check" >> $env:GITHUB_OUTPUT
28+
29+
project:
30+
name: Add pull request to project
31+
needs: check
32+
if: |
33+
needs.check.outputs.title == 'true'
34+
runs-on: ubuntu-latest
35+
steps:
36+
- uses: actions-ecosystem/action-add-labels@v1
37+
with:
38+
labels: project-quality

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