Skip to content

Update freshness of community content #11960

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 27, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -17,5 +17,4 @@ updatablehelp/
xhtml/
**/settings.json
StaleContentReport.*.csv
.vscode/styles
.vale/
2 changes: 1 addition & 1 deletion reference/docs-conceptual/community/2020-updates.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
description: List of changes to the PowerShell documentation for 2020
ms.date: 02/02/2023
ms.date: 03/30/2025
title: What's New in PowerShell Docs for 2020
---

Expand Down
2 changes: 1 addition & 1 deletion reference/docs-conceptual/community/2021-updates.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
description: List of changes to the PowerShell documentation for 2021
ms.date: 02/02/2023
ms.date: 03/30/2025
title: What's New in PowerShell-Docs for 2021
---
# What's new in PowerShell Docs for 2021
Expand Down
2 changes: 1 addition & 1 deletion reference/docs-conceptual/community/2022-updates.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
description: List of changes to the PowerShell documentation for 2022
ms.date: 06/28/2023
ms.date: 03/30/2025
title: What's New in PowerShell-Docs for 2022
---
# What's new in PowerShell Docs for 2022
Expand Down
2 changes: 1 addition & 1 deletion reference/docs-conceptual/community/2023-updates.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
description: List of changes to the PowerShell documentation for 2023
ms.date: 01/02/2024
ms.date: 03/30/2025
title: What's New in PowerShell-Docs for 2023
---
# What's new in PowerShell Docs for 2023
Expand Down
2 changes: 1 addition & 1 deletion reference/docs-conceptual/community/2024-updates.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
description: List of changes to the PowerShell documentation for 2024
ms.date: 01/02/2025
ms.date: 03/30/2025
title: What's New in PowerShell-Docs for 2024
---
# What's new in PowerShell Docs for 2024
Expand Down
39 changes: 25 additions & 14 deletions reference/docs-conceptual/community/community-support.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,37 @@
---
description: List of resources created for and by PowerShell users
ms.date: 11/16/2022
ms.date: 03/30/2025
title: PowerShell community support resources
---
# Getting support from the community

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

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

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

For information about our support policy, see the
[PowerShell Support Lifecycle](/powershell/scripting/powershell-support-lifecycle).
For information about our support policy, see the [PowerShell Support Lifecycle][01].

<!-- link references -->
[01]: /powershell/scripting/powershell-support-lifecycle
[02]: https://aka.ms/psdiscord
[03]: https://aka.ms/psslack
[04]: https://aka.ms/psusergroup
[05]: https://dsccommunity.org/
[06]: https://forums.powershell.org/
[07]: https://github.com/powershell/powershell/issues
[08]: https://stackoverflow.com/questions/tagged/powershell
[09]: https://techcommunity.microsoft.com/t5/PowerShell/ct-p/WindowsPowerShell
[10]: https://www.reddit.com/r/PowerShell/
2 changes: 1 addition & 1 deletion reference/docs-conceptual/community/community-update.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ metadata:
ms.topic: landing-page # Required
author: sdwheeler #Required; your GitHub user alias, with correct capitalization.
ms.author: sewhee #Required; Microsoft alias of author; optional team alias.
ms.date: 02/03/2025
ms.date: 03/30/2025

# linkListType: architecture | concept | deploy | download | get-started | how-to-guide | learn |
# overview | quickstart | reference | tutorial | video | whats-new
Expand Down
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
---
description: This is a summarized list of rules for editing PowerShell documentation.
ms.date: 11/16/2022
description: This article contains a summarized list of rules for editing PowerShell documentation.
ms.date: 03/30/2025
title: Editorial checklist
---
# Editor's checklist

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

## Metadata

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

### Headers

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

### Code blocks

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

### Lists

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

## Terminology

- PowerShell vs. Windows PowerShell
- Use _PowerShell_ vs. _Windows PowerShell_
- See [Product Terminology][3]

## Cmdlet reference examples

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

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

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
description: This article explains how to give feedback about the PowerShell documentation.
ms.date: 07/26/2022
ms.date: 03/30/2025
title: How to file a PowerShell-Docs issue
---
# How to file a PowerShell-Docs issue
Expand All @@ -15,24 +15,23 @@ There are two ways to create an issue:
For a full description of the feedback controls, see the Docs Team blog announcing this
[feature][1].

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

> [!NOTE]
> The feedback tool not a support channel. This is a way to ask questions to clarify documentation
> or to report errors and omissions. If you need technical support, see [Community resources][2].
> The feedback tool not a support channel. It's a way to ask questions to clarify documentation or
> to report errors and omissions. If you need technical support, see [Community resources][2].

## Filing issues on GitHub

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

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

## Next steps

Expand Down
Loading