Skip to content

Commit dd76f2b

Browse files
authored
Update freshness and remove v1.x configs (#324)
1 parent 78a1b6f commit dd76f2b

4 files changed

Lines changed: 43 additions & 63 deletions

File tree

powershell-gallery/docfx.json

Lines changed: 1 addition & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,6 @@
1010
{ "dest": "gallery", "files": [ "breadcrumb/toc.yml" ] },
1111
{ "dest": "gallery", "files": [ "**/*.md", "**/*.yml" ], "group": "conceptual", "src": "docs-conceptual" },
1212

13-
{ "dest": "module/powershellget", "files": [ "toc.yml" ], "group": "powershellget-1.x", "src": "powershellget-1.x" },
14-
{ "dest": "module", "exclude": [ "docs-conceptual/**" ], "files": [ "**/*.yml", "**/About/*.md" ], "group": "powershellget-1.x", "src": "powershellget-1.x" },
15-
1613
{ "dest": "module/powershellget", "files": [ "toc.yml" ], "group": "powershellget-2.x", "src": "powershellget-2.x" },
1714
{ "dest": "module", "exclude": [ "docs-conceptual/**" ], "files": [ "**/*.yml", "**/About/*.md" ], "group": "powershellget-2.x", "src": "powershellget-2.x" },
1815

@@ -31,7 +28,6 @@
3128
"docs-conceptual/concepts/**/*": "https://github.com/powershell/powershellgallery/issues/new",
3229
"docs-conceptual/how-to/**/*": "https://github.com/powershell/powershellgallery/issues/new",
3330
"docs-conceptual/powershellget/**/*": "https://github.com/powershell/psresourceget/issues/new",
34-
"powershellget-1.x/**/*": "https://github.com/powershell/powershellget/issues/new",
3531
"powershellget-2.x/**/*": "https://github.com/powershell/powershellget/issues/new",
3632
"powershellget-3.x/**/*": "https://github.com/powershell/psresourceget/issues/new"
3733
},
@@ -40,13 +36,10 @@
4036
"docs-conceptual/concepts/**/*": "PowerShell Gallery",
4137
"docs-conceptual/how-to/**/*": "PowerShell Gallery",
4238
"docs-conceptual/powershellget/**/*": "PowerShellGet",
43-
"powershellget-1.x/**/*": "PowerShellGet",
4439
"powershellget-2.x/**/*": "PowerShellGet",
4540
"powershellget-3.x/**/*": "PSResourceGet"
4641
},
4742
"ms.subservice": {
48-
"powershellget-1.x/**/*.md": "conceptual",
49-
"powershellget-1.x/**/*.yml": "cmdlets",
5043
"powershellget-2.x/**/*.md": "conceptual",
5144
"powershellget-2.x/**/*.yml": "cmdlets",
5245
"powershellget-3.x/**/*.md": "conceptual",
@@ -55,12 +48,10 @@
5548
"ms.topic": {
5649
"docs-conceptual/**/*": "concept-article",
5750
"docs-conceptual/**/how-to/**": "how-to",
58-
"powershellget-1.x/**/*": "reference",
5951
"powershellget-2.x/**/*": "reference",
6052
"powershellget-3.x/**/*": "reference"
6153
},
6254
"ms.update-cycle": {
63-
"powershellget-1.x/**/*": "3650-days",
6455
"powershellget-2.x/**/*": "3650-days",
6556
"docs-conceptual/faqs.yml": "3650-days",
6657
"docs-conceptual/concepts/**/*": "3650-days",
@@ -71,10 +62,6 @@
7162
"https://authoring-docs-microsoft.poolparty.biz/devrel/2bdae855-045f-4535-b365-7b2e23824328",
7263
"https://authoring-docs-microsoft.poolparty.biz/devrel/8bce367e-2e90-4b56-9ed5-5e4e9f3a2dc3"
7364
],
74-
"powershellget-1.x/**/*": [
75-
"https://authoring-docs-microsoft.poolparty.biz/devrel/56936876-97d9-45cc-ad1b-9d63320447c8",
76-
"https://authoring-docs-microsoft.poolparty.biz/devrel/8bce367e-2e90-4b56-9ed5-5e4e9f3a2dc3"
77-
],
7865
"powershellget-2.x/**/*": [
7966
"https://authoring-docs-microsoft.poolparty.biz/devrel/56936876-97d9-45cc-ad1b-9d63320447c8",
8067
"https://authoring-docs-microsoft.poolparty.biz/devrel/8bce367e-2e90-4b56-9ed5-5e4e9f3a2dc3"
@@ -111,8 +98,7 @@
11198
"uhfHeaderId": "MSDocsHeader-Powershell"
11299
},
113100
"groups": {
114-
"conceptual": { "moniker_range": ">=powershellget-1.x" },
115-
"powershellget-1.x": { "moniker_range": "powershellget-1.x" },
101+
"conceptual": { "moniker_range": ">=powershellget-2.x" },
116102
"powershellget-2.x": { "moniker_range": "powershellget-2.x" },
117103
"powershellget-3.x": { "moniker_range": "powershellget-3.x" }
118104
},

powershell-gallery/docs-conceptual/faqs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
### YamlMime:FAQ
22
metadata:
3-
ms.date: 06/12/2017
3+
ms.date: 01/28/2026
44
title: PowerShell Gallery FAQs
55
description: Frequently asked questions about the PowerShell Gallery
66
ms.topic: faq

powershell-gallery/docs-conceptual/getting-started.md

Lines changed: 37 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,16 @@
11
---
22
description: This article explains how to get started using the PowerShell Gallery and the PowerShellGet cmdlets
3-
ms.date: 09/09/2025
3+
ms.date: 01/28/2026
44
ms.topic: get-started
55
title: Get Started with the PowerShell Gallery
66
---
77
# Getting Started with the PowerShell Gallery
88

99
The PowerShell Gallery is a package repository containing scripts, modules, and DSC resources you
10-
can download and leverage. You use the cmdlets in the [PowerShellGet][03] module to install packages
10+
can download and use. You use the cmdlets in the [PowerShellGet][03] module to install packages
1111
from the PowerShell Gallery. You don't need to sign in to download items from the PowerShell
1212
Gallery.
1313

14-
> [!NOTE]
15-
> It's possible to download a package from the PowerShell Gallery directly, but this isn't a
16-
> recommended approach. For more details, see [Manual Package Download][18].
17-
1814
## Discovering packages from the PowerShell Gallery
1915

2016
You can find packages in the PowerShell Gallery using the **Search** control on the PowerShell
@@ -43,13 +39,13 @@ Because DSC resources are always delivered as part of a module, you still need t
4339

4440
## Learning about packages in the PowerShell Gallery
4541

46-
Once you've identified a package that you're interested in, you may want to learn more about it. You
47-
can do this by examining that package's specific page on the Gallery. On that page, you'll be able
48-
to see all the metadata uploaded with the package. This metadata is provided by the package's
49-
author, and is not verified by Microsoft. The Owner of the package is strongly tied to the Gallery
50-
account used to publish the package, and is more trustworthy than the Author field.
42+
After you select a package, you may want to learn more about it. Examine the package page on the
43+
Gallery. The package page includes the metadata uploaded with the package. The metadata is provided
44+
by the author of the package. Microsoft doesn't verify this information. The Owner of the package is
45+
associated with the Gallery account used to publish the package. The Owner account is more
46+
authoritative than the Author field.
5147

52-
If you discover a package that you feel isn't published in good faith, click **Report Abuse** on
48+
If you discover a package that you feel isn't published in good faith, select **Report Abuse** on
5349
that package's page.
5450

5551
If you're running `Find-Module` or `Find-Script`, you can view this data in the returned
@@ -66,63 +62,62 @@ We encourage the following process when downloading packages from the PowerShell
6662

6763
### Inspect
6864

69-
To download a package from the Gallery for inspection, run either the `Save-Module` or `Save-Script`
70-
cmdlet, depending on the package type. This lets you save the package locally without installing it,
71-
and inspect the package contents. Remember to delete the saved package manually.
65+
To download a package from the Gallery for inspection, use the `Save-Module` or `Save-Script`
66+
cmdlets on the package. These commands save the package locally without installing it. Inspect the
67+
package contents. Remember to delete the saved package manually.
7268

73-
Some of these packages are authored by Microsoft, and others are authored by the PowerShell
74-
community. Microsoft recommends that you review the contents and code of packages on this gallery
75-
before installation.
69+
Some packages are authored by Microsoft, and others are authored by the PowerShell community.
70+
Microsoft recommends that you review the contents and code of packages on this gallery before
71+
installation.
7672

77-
If you discover a package that you feel isn't published in good faith, click **Report Abuse** on
73+
If you discover a package that you feel isn't published in good faith, select **Report Abuse** on
7874
that package's page.
7975

8076
### Install
8177

8278
To install a package from the Gallery for use, run either the `Install-Module` or `Install-Script`
8379
cmdlet, depending on the package type.
8480

85-
`Install-Module` installs the module to `$env:ProgramFiles\WindowsPowerShell\Modules` by default.
86-
This requires an administrator account. If you add the `-Scope CurrentUser` parameter, the module is
87-
installed to `$HOME\Documents\WindowsPowerShell\Modules` .
81+
By default, `Install-Module` installs the module to `$env:ProgramFiles\WindowsPowerShell\Modules`
82+
location by default, which requires an administrator account. If you add the `-Scope CurrentUser`
83+
parameter, the command installs the module in `$HOME\Documents\WindowsPowerShell\Modules` .
8884

89-
`Install-Script` installs the script to `$env:ProgramFiles\WindowsPowerShell\Scripts` by default.
90-
This requires an administrator account. If you add the `-Scope CurrentUser` parameter, the script is
91-
installed to `$HOME\Documents\WindowsPowerShell\Scripts` .
85+
By default, `Install-Script` installs the script to `$env:ProgramFiles\WindowsPowerShell\Scripts`
86+
location, which requires an administrator account. If you add the `-Scope CurrentUser` parameter,
87+
the command installs the script in `$HOME\Documents\WindowsPowerShell\Scripts`.
9288

93-
By default, `Install-Module` and `Install-Script` installs the most
94-
current version of a package. To install an older version of the package, add the `-RequiredVersion`
95-
parameter.
89+
`Install-Module` and `Install-Script` installs the most current version of a package. To install an
90+
older version of the package, add the `-RequiredVersion` parameter.
9691

9792
### Deploy
9893

99-
To deploy a package from the PowerShell Gallery to Azure Automation, click **Azure Automation**,
100-
then click **Deploy to Azure Automation** on the package details page. You are redirected to the
101-
Azure Management Portal where you sign in using your Azure account credentials. Note that
102-
deploying packages with dependencies deploys all the dependencies to Azure Automation. The 'Deploy
103-
to Azure Automation' button can be disabled by adding the **AzureAutomationNotSupported** tag to
104-
your package metadata.
94+
To deploy a package from the PowerShell Gallery to Azure Automation, select **Azure Automation**,
95+
then select **Deploy to Azure Automation** on the package details page. You're redirected to the
96+
Azure Management Portal where you sign in using your Azure account credentials. Deploying packages
97+
with dependencies deploys all the dependencies to Azure Automation. The **Deploy to Azure
98+
Automation** button can be disabled by adding the **AzureAutomationNotSupported** tag to your
99+
package metadata.
105100

106101
To learn more about Azure Automation, see the [Azure Automation][02] documentation.
107102

108103
## Updating packages from the PowerShell Gallery
109104

110105
To update packages installed from the PowerShell Gallery, run either the `Update-Module` or
111-
`Update-Script` cmdlet. When run without any additional parameters, `Update-Module` attempts to
106+
`Update-Script` cmdlet. When run without any other parameters, `Update-Module` attempts to
112107
update all modules installed by running `Install-Module`. To selectively update modules, add the
113108
`-Name` parameter.
114109

115-
Similarly, when run without any additional parameters, `Update-Script` also attempts to update all
110+
Similarly, when run without any other parameters, `Update-Script` also attempts to update all
116111
scripts installed by running `Install-Script`. To selectively update scripts, add the `-Name`
117112
parameter.
118113

119-
## List packages that you have installed from the PowerShell Gallery
114+
## List packages that you installed from the PowerShell Gallery
120115

121-
To find out which modules you have installed from the PowerShell Gallery, run the
122-
`Get-InstalledModule` cmdlet. This command lists all the modules you have on your system that were
123-
installed directly from the PowerShell Gallery.
116+
To find out which modules you installed from the PowerShell Gallery, run the `Get-InstalledModule`
117+
cmdlet. This command lists all the modules you have on your system that were installed directly from
118+
the PowerShell Gallery.
124119

125-
Similarly, to find out which scripts you have installed from the PowerShell Gallery, run the
120+
Similarly, to find out which scripts you installed from the PowerShell Gallery, run the
126121
`Get-InstalledScript` cmdlet. This command lists all the scripts you have on your system that were
127122
installed directly from the PowerShell Gallery.
128123

@@ -143,8 +138,7 @@ Hosts required when using the PowerShell Gallery website:
143138
- `go.microsoft.com` and `aka.ms` - redirection services
144139

145140
> [!NOTE]
146-
> These endpoints have changed. The old endpoints that ended with `azureedge.net` are no longer
147-
> supported.
141+
> The old endpoints that ended with `azureedge.net` are no longer supported.
148142
149143
## Related links
150144

powershell-gallery/docs-conceptual/powershellget/how-to/credential-persistence.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -69,15 +69,15 @@ PSGallery https://www.powershellgallery.com/api/v2
6969
## Publishing resources to the repository
7070

7171
To publish resources to a secured repository, you must provide the credential you configured. This
72-
example show how to publish a resource to the `artifactory` repository using your stored credential.
72+
example shows how to publish a resource to the `artifactory` repository using your stored credential.
7373

7474
```powershell
7575
Publish-PSResource -Path .\Get-Hello\ -Repository artifactory -ApiKey (Get-Secret JFrogPublish)
7676
```
7777

78-
Once you have provided the credential, **PowerShellGet** reuses the credential for subsequent
79-
commands that target the same repository. The following examples show how to find and install a
80-
resource. Notice that the credential isn't required.
78+
**PowerShellGet** reuses the credential for subsequent commands that target the same repository. The
79+
following examples show how to find and install a resource. Notice that the credential isn't
80+
required.
8181

8282
```powershell
8383
Find-PSResource -Name Get-Hello -Repository artifactory

0 commit comments

Comments
 (0)