From 760006cb74e24fa7d8e0f07a910ae74f8e7a527a Mon Sep 17 00:00:00 2001 From: Sean Wheeler Date: Tue, 27 Jan 2026 09:32:34 -0600 Subject: [PATCH 1/2] Update README and markdownlint rules --- .markdownlint.yaml | 30 +++++++++++++++++------------- README.md | 29 ++++++++++++++--------------- 2 files changed, 31 insertions(+), 28 deletions(-) diff --git a/.markdownlint.yaml b/.markdownlint.yaml index a794811..f47a0ca 100644 --- a/.markdownlint.yaml +++ b/.markdownlint.yaml @@ -1,16 +1,3 @@ -docsmd.alert: true -docsmd.codesnippet: true -docsmd.column: true -docsmd.image: true -docsmd.moniker: true -docsmd.no-loc: true -docsmd.row: true -docsmd.securelinks: true -docsmd.syntax: true -docsmd.video: true -docsmd.xref: true -docsmd.zone: true - MD001: true # header-increment # MD002 # first-header-h1 - Superceded by MD041 MD003: # header-style @@ -115,3 +102,20 @@ MD050: # strong-style MD051: true # link-fragments MD052: true # reference-links-images MD053: true # link-image-reference-definitions +MD054: # link-image-style + autolink: false # Allow autolinks + collapsed: false # Allow collapsed reference links and images + full: true # Allow full reference links and images + inline: true # Allow inline links and images + shortcut: false # Allow shortcut reference links and images + url_inline: true # Allow URLs as inline links +MD055: # table-pipe-style + style: leading_and_trailing +MD056: true # table-column-count +# MD057: # not used by linter - never defined +MD058: true # blanks-around-tables +MD059: # descriptive-link-text + prohibited_texts: ["click here","here","link","more"] +MD060: # table-column-style + aligned_delimiter: false + style: any diff --git a/README.md b/README.md index ea24483..f283b6b 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ --- -ms.date: 01/03/2025 +ms.date: 01/27/2026 --- -# PowerShellGet & PSGallery documentation +# Package manager & PSGallery documentation -Welcome to the PowerShell-Docs-PSGet repository, the home of the official -documentation for PowerShellGet and the PowerShell Gallery. +Welcome to the PowerShell-Docs-PSGet repository, the home of the official documentation for +PSResourceGet, PowerShellGet, and the PowerShell Gallery. ## Microsoft Open Source Code of Conduct @@ -14,29 +14,26 @@ This project has adopted the [Microsoft Open Source Code of Conduct][coc]. [![Build Status][cabgen-status]][cabgen-log] -[cabgen-status]: https://apidrop.visualstudio.com/Content%20CI/_apis/build/status/PROD/CabGen(PowerShell_Updatable_Help)/GitHub_MicrosoftDocs_PowerShell-Docs-PSGet/8f69f151-baa4-9541-9991-266b76474533_cabgen_Publish-Updatable-Help?repoName=MicrosoftDocs%2FPowerShell-Docs-PSGet&branchName=live -[cabgen-log]: https://apidrop.visualstudio.com/Content%20CI/_build/latest?definitionId=5501&repoName=MicrosoftDocs%2FPowerShell-Docs-PSGet&branchName=live - ## Repository Structure The following list describes the main folders in this repository. +- `.devcontainer` - contains devcontainer settings used by GitHub Codespaces and Visual Studio Code + (VS Code) Remote - Containers extension - `.github` - contains configuration settings used by GitHub for this repository -- `.vscode` - contains configuration settings and recommended extensions for Visual Studio Code (VS - Code) +- `.vscode` - contains configuration settings and recommended extensions for VS Code - `powershell-gallery` - contains the documentation published to [learn.microsoft.com/powershell/gallery][04]. This includes both reference and conceptual content. - - `powershellget-1.x` - contains the cmdlet reference and about topics for PowerShellGet 1.x - - `powershellget-2.x` - contains the cmdlet reference and about topics for PowerShellGet 2.x - - `powershellget-3.x` - contains the cmdlet reference and about topics for PowerShellGet 3.x - `breadcrumb` - contains the TOC used for breadcrumb navigation - `docs-conceptual` - contains the conceptual articles that are published to the Docs site. In general, the folder structure mirrors the Table of Contents (TOC). + - `media` - contains image files used in documentation. There are media folders throughout the + `docs-conceptual` content. See the Contributor Guide for information on using images in + documentation. - `includes` - contains markdown include files - `mapping` - contains the version mapping configuration used by the build system - - `media` - contains image files used in documentation. There are media folders throughout the - `docs-conceptual` content. See the Contributor Guide for information on using images in - documentation. + - `powershellget-2.x` - contains the cmdlet reference and about topics for PowerShellGet 2.x + - `powershellget-3.x` - contains the cmdlet reference and about topics for PSResourceGet > [!NOTE] > The reference content (in the numbered folders) is used to create the webpages on the Docs site as @@ -64,3 +61,5 @@ repo. The Creative Commons license applies to the documentation. [03]: https://cla.microsoft.com/ [04]: https://learn.microsoft.com/powershell/gallery/ [coc]: CODE_OF_CONDUCT.md +[cabgen-status]: https://apidrop.visualstudio.com/Content%20CI/_apis/build/status/PROD/CabGen(PowerShell_Updatable_Help)/GitHub_MicrosoftDocs_PowerShell-Docs-PSGet/8f69f151-baa4-9541-9991-266b76474533_cabgen_Publish-Updatable-Help?repoName=MicrosoftDocs%2FPowerShell-Docs-PSGet&branchName=live +[cabgen-log]: https://apidrop.visualstudio.com/Content%20CI/_build/latest?definitionId=5501&repoName=MicrosoftDocs%2FPowerShell-Docs-PSGet&branchName=live From b5483abd92f2b35ff298d742d6ef015758d6f0c4 Mon Sep 17 00:00:00 2001 From: Sean Wheeler Date: Tue, 27 Jan 2026 09:40:09 -0600 Subject: [PATCH 2/2] Update comments --- .markdownlint.yaml | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/.markdownlint.yaml b/.markdownlint.yaml index f47a0ca..a7ab883 100644 --- a/.markdownlint.yaml +++ b/.markdownlint.yaml @@ -103,12 +103,12 @@ MD051: true # link-fragments MD052: true # reference-links-images MD053: true # link-image-reference-definitions MD054: # link-image-style - autolink: false # Allow autolinks - collapsed: false # Allow collapsed reference links and images - full: true # Allow full reference links and images - inline: true # Allow inline links and images - shortcut: false # Allow shortcut reference links and images - url_inline: true # Allow URLs as inline links + autolink: false # Allow autolinks (default true) + collapsed: false # Allow collapsed reference links and images (default true) + full: true # Allow full reference links and images (default true) + inline: true # Allow inline links and images (default true) + shortcut: false # Allow shortcut reference links and images (default true) + url_inline: true # Allow URLs as inline links (default true) MD055: # table-pipe-style style: leading_and_trailing MD056: true # table-column-count