Skip to content

Commit 9d9e52f

Browse files
authored
Update freshness of community content (#11960)
* remove .vscode/styles from .gitignore * Update freshness of community content Full Acrolinx pass
1 parent d8feba0 commit 9d9e52f

23 files changed

+261
-256
lines changed

.gitignore

-1
Original file line numberDiff line numberDiff line change
@@ -17,5 +17,4 @@ updatablehelp/
1717
xhtml/
1818
**/settings.json
1919
StaleContentReport.*.csv
20-
.vscode/styles
2120
.vale/

reference/docs-conceptual/community/2020-updates.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
description: List of changes to the PowerShell documentation for 2020
3-
ms.date: 02/02/2023
3+
ms.date: 03/30/2025
44
title: What's New in PowerShell Docs for 2020
55
---
66

reference/docs-conceptual/community/2021-updates.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
description: List of changes to the PowerShell documentation for 2021
3-
ms.date: 02/02/2023
3+
ms.date: 03/30/2025
44
title: What's New in PowerShell-Docs for 2021
55
---
66
# What's new in PowerShell Docs for 2021

reference/docs-conceptual/community/2022-updates.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
description: List of changes to the PowerShell documentation for 2022
3-
ms.date: 06/28/2023
3+
ms.date: 03/30/2025
44
title: What's New in PowerShell-Docs for 2022
55
---
66
# What's new in PowerShell Docs for 2022

reference/docs-conceptual/community/2023-updates.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
description: List of changes to the PowerShell documentation for 2023
3-
ms.date: 01/02/2024
3+
ms.date: 03/30/2025
44
title: What's New in PowerShell-Docs for 2023
55
---
66
# What's new in PowerShell Docs for 2023

reference/docs-conceptual/community/2024-updates.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
description: List of changes to the PowerShell documentation for 2024
3-
ms.date: 01/02/2025
3+
ms.date: 03/30/2025
44
title: What's New in PowerShell-Docs for 2024
55
---
66
# What's new in PowerShell Docs for 2024
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,37 @@
11
---
22
description: List of resources created for and by PowerShell users
3-
ms.date: 11/16/2022
3+
ms.date: 03/30/2025
44
title: PowerShell community support resources
55
---
66
# Getting support from the community
77

88
The PowerShell Community is a vibrant and active group of users. This article can help you get
99
connected with other member of the community.
1010

11-
The PowerShell community can file issues, bugs, or feature requests in our
12-
[GitHub](https://github.com/powershell/powershell/issues) repository. If you have questions, you may
13-
find help from other members of the community in one of these public forums:
11+
The PowerShell community can file issues, bugs, or feature requests in our [GitHub][07] repository.
12+
If you have questions, you may find help from other members of the community in one of these public
13+
forums:
1414

15-
- [User Groups](https://aka.ms/psusergroup)
16-
- [PowerShell Tech Community](https://techcommunity.microsoft.com/t5/PowerShell/ct-p/WindowsPowerShell)
17-
- [DSC Community](https://dsccommunity.org/)
18-
- [PowerShell.org](https://forums.powershell.org/)
19-
- [Stack Overflow](https://stackoverflow.com/questions/tagged/powershell)
20-
- [r/PowerShell subreddit](https://www.reddit.com/r/PowerShell/)
15+
- [User Groups][04]
16+
- [PowerShell Tech Community][09]
17+
- [DSC Community][05]
18+
- [PowerShell.org][06]
19+
- [Stack Overflow][08]
20+
- [r/PowerShell subreddit][10]
2121
- PowerShell Virtual User Group - join via:
22-
- [Slack](https://aka.ms/psslack)
23-
- [Discord](https://aka.ms/psdiscord)
22+
- [Slack][03]
23+
- [Discord][02]
2424

25-
For information about our support policy, see the
26-
[PowerShell Support Lifecycle](/powershell/scripting/powershell-support-lifecycle).
25+
For information about our support policy, see the [PowerShell Support Lifecycle][01].
26+
27+
<!-- link references -->
28+
[01]: /powershell/scripting/powershell-support-lifecycle
29+
[02]: https://aka.ms/psdiscord
30+
[03]: https://aka.ms/psslack
31+
[04]: https://aka.ms/psusergroup
32+
[05]: https://dsccommunity.org/
33+
[06]: https://forums.powershell.org/
34+
[07]: https://github.com/powershell/powershell/issues
35+
[08]: https://stackoverflow.com/questions/tagged/powershell
36+
[09]: https://techcommunity.microsoft.com/t5/PowerShell/ct-p/WindowsPowerShell
37+
[10]: https://www.reddit.com/r/PowerShell/

reference/docs-conceptual/community/community-update.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ metadata:
99
ms.topic: landing-page # Required
1010
author: sdwheeler #Required; your GitHub user alias, with correct capitalization.
1111
ms.author: sewhee #Required; Microsoft alias of author; optional team alias.
12-
ms.date: 02/03/2025
12+
ms.date: 03/30/2025
1313

1414
# linkListType: architecture | concept | deploy | download | get-started | how-to-guide | learn |
1515
# overview | quickstart | reference | tutorial | video | whats-new

reference/docs-conceptual/community/contributing/editorial-checklist.md

+23-22
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
---
2-
description: This is a summarized list of rules for editing PowerShell documentation.
3-
ms.date: 11/16/2022
2+
description: This article contains a summarized list of rules for editing PowerShell documentation.
3+
ms.date: 03/30/2025
44
title: Editorial checklist
55
---
66
# Editor's checklist
77

8-
This is a summary of rules to apply when writing new or updating existing articles. See other
9-
articles in the Contributor's Guide for detailed explanations and examples of these rules.
8+
This article contains a summarized list of rules for writing or editing PowerShell documentation.
9+
See other articles in the Contributor's Guide for detailed explanations and examples of these rules.
1010

1111
## Metadata
1212

1313
- `ms.date`: must be in the format **MM/DD/YYYY**
14-
- Change the date when there is a significant or factual update
14+
- Change the date when there's a significant or factual update
1515
- Reorganizing the article
1616
- Fixing factual errors
1717
- Adding new information
@@ -31,7 +31,7 @@ articles in the Contributor's Guide for detailed explanations and examples of th
3131
- File paths `C:\Program Files\PowerShell`, `/usr/bin/pwsh`
3232
- URLs that aren't meant to be clickable in the document
3333
- Property or parameter values
34-
- Use bold for property names, parameter names, class names, module names, entity names, object or
34+
- Use bold for property names, parameter names, class names, module names, entity names, object, or
3535
type names
3636
- Bold is used for semantic markup, not emphasis
3737
- Bold - use asterisks `**`
@@ -45,39 +45,39 @@ articles in the Contributor's Guide for detailed explanations and examples of th
4545

4646
### Headers
4747

48-
- H1 is first - only one H1 per article
48+
- Start with H1 first - only one H1 per article
4949
- Use [ATX Headers][1] only
5050
- Use sentence case for all headers
5151
- Don't skip levels - no H3 without an H2
52-
- Max depth of H3 or H4
53-
- Blank line before and after
54-
- PlatyPS enforces specific headers in its schema - don't add or remove headers
52+
- Limit header depth to H3 or H4
53+
- Add blank lines before and after
54+
- Don't add or remove headers - PlatyPS enforces specific headers in its schema
5555

5656
### Code blocks
5757

58-
- Blank line before and after
58+
- Add blank lines before and after
5959
- Use tagged code fences - **powershell**, **Output**, or other appropriate language ID
60-
- Untagged fence - syntax blocks or other shells
61-
- Put output in separate code block except for basic examples where you don't intend the for the
60+
- Use untagged code fence for syntax blocks
61+
- Put output in separate code block except for basic examples where you don't intend for the
6262
reader to use the **Copy** button
6363
- See list of [supported languages][2]
6464

6565
### Lists
6666

67-
- Indented properly
68-
- Blank line before first item and after last item
69-
- Bullet - use hyphen (`-`) not asterisk (`*`) to reduce confusion with emphasis
70-
- For numbered lists, all numbers are "1."
67+
- Indent properly
68+
- Add blank lines before first item and after last item
69+
- Use hyphen (`-`) for bullets not asterisk (`*`) to reduce confusion with emphasis
70+
- Use `1.` for all items in a numbered list
7171

7272
## Terminology
7373

74-
- PowerShell vs. Windows PowerShell
74+
- Use _PowerShell_ vs. _Windows PowerShell_
7575
- See [Product Terminology][3]
7676

7777
## Cmdlet reference examples
7878

7979
- Must have at least one example in cmdlet reference
80-
- Examples should be just enough code to demonstrate the usage
80+
- Examples should be only enough code to demonstrate the usage
8181
- PowerShell syntax
8282
- Use full names of cmdlets and parameters - no aliases
8383
- Use splatting for parameters when the command line gets too long
@@ -108,11 +108,12 @@ articles in the Contributor's Guide for detailed explanations and examples of th
108108
## Linking to other documents
109109

110110
- When linking outside the docset or between cmdlet reference and conceptual
111-
- Use site-relative URLs when linking to Microsoft Learn (remove `https://learn.microsoft.com/en-us`)
112-
- don't include locales in URLs on Microsoft properties (eg. remove `/en-us` from URL)
111+
- Use site-relative URLs when linking to Microsoft Learn (remove
112+
`https://learn.microsoft.com/en-us`)
113+
- don't include locales in URLs on Microsoft properties (remove `/en-us` from URL)
113114
- All URLs to external websites should use HTTPS unless that's not valid for the target site
114115
- When linking within the docset
115-
- Use the relative filepath (e.g. `../folder/file.md`)
116+
- Use the relative filepath (`../folder/file.md`)
116117
- All paths use forward-slash (`/`) characters
117118
- Image links should have unique alt text
118119

reference/docs-conceptual/community/contributing/file-an-issue.md

+8-9
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
description: This article explains how to give feedback about the PowerShell documentation.
3-
ms.date: 07/26/2022
3+
ms.date: 03/30/2025
44
title: How to file a PowerShell-Docs issue
55
---
66
# How to file a PowerShell-Docs issue
@@ -15,24 +15,23 @@ There are two ways to create an issue:
1515
For a full description of the feedback controls, see the Docs Team blog announcing this
1616
[feature][1].
1717

18-
At the bottom of most pages on `learn.microsoft.com`, you'll see two feedback buttons. One is a link
18+
At the bottom of most pages on `learn.microsoft.com`, there are two feedback buttons. One is a link
1919
for product feedback and one is for documentation feedback. The documentation feedback requires a
2020
GitHub account. Clicking the button takes you in GitHub and presents an issue template. Enter your
2121
feedback and submit the form.
2222

2323
> [!NOTE]
24-
> The feedback tool not a support channel. This is a way to ask questions to clarify documentation
25-
> or to report errors and omissions. If you need technical support, see [Community resources][2].
24+
> The feedback tool not a support channel. It's a way to ask questions to clarify documentation or
25+
> to report errors and omissions. If you need technical support, see [Community resources][2].
2626
2727
## Filing issues on GitHub
2828

29-
To file a GitHub issue directly, you can click the [New issue][3] button in the PowerShell-Docs
30-
repository. Click the **Get started** button for the issue you want to create. The GitHub issue
29+
To file a GitHub issue directly, you can select the [New issue][3] button in the PowerShell-Docs
30+
repository. Select the **Get started** button for the issue you want to create. The GitHub issue
3131
template helps you provide the information needed to address the problem you're reporting.
3232

33-
Before you file a new issue, read through existing issues to see if your problem has already been
34-
reported. This helps avoid duplication and your issue may have been answered already. If you find an
35-
existing issue, you can add your comments, related questions, or answers.
33+
To avoid duplication, search the existing issues to see if someone else has already reported it. If
34+
you find an existing issue, you can add your comments, related questions, or answers.
3635

3736
## Next steps
3837

0 commit comments

Comments
 (0)