From c8bae1fa54553b4d302584cef8ea8a00c71f4a3f Mon Sep 17 00:00:00 2001 From: Sean Wheeler Date: Thu, 18 Aug 2022 14:12:57 -0500 Subject: [PATCH] Add CrescendoBuilt tag to list of preferred tags --- .../concepts/package-manifest-affecting-ui.md | 103 +++++++++--------- reference/docs-conceptual/gallery/toc.yml | 95 ++++++++++++++++ reference/docs-conceptual/toc.yml | 94 ---------------- 3 files changed, 147 insertions(+), 145 deletions(-) create mode 100644 reference/docs-conceptual/gallery/toc.yml diff --git a/reference/docs-conceptual/gallery/concepts/package-manifest-affecting-ui.md b/reference/docs-conceptual/gallery/concepts/package-manifest-affecting-ui.md index e9fa10a85faf..06415694fe9e 100644 --- a/reference/docs-conceptual/gallery/concepts/package-manifest-affecting-ui.md +++ b/reference/docs-conceptual/gallery/concepts/package-manifest-affecting-ui.md @@ -1,6 +1,6 @@ --- description: This article documents the package metadata values that are used by the PowerShell Gallery. -ms.date: 08/11/2022 +ms.date: 08/18/2022 title: Package metadata values that impact the PowerShell Gallery UI --- # Package metadata values that impact the PowerShell Gallery UI @@ -207,68 +207,69 @@ best search results. | Preferred tag | Alternatives and notes | | ----------------- | ----------------------------------------------------------------------------------------------- | -| Azure | | -| DSC | DesiredStateConfiguration is less desirable, it's too long | -| ResourceManager | "Arm" is used to describe group of processors, and shouldn't be used for Azure Resource Manager | -| DSCResourceKit | | -| SQL | | -| AWS | | -| DSCResource | | -| Automation | | -| REST | | | ActiveDirectory | AD isn't currently used by itself | -| SQLServer | | -| DBA | | -| Security | Defense is less precise | -| Database | Databases (plural) is less desirable | -| DevOps | | -| Windows | | +| Appveyor | | +| Automation | | +| AWS | | +| Azure | | +| AzureAD | | +| AzureAutomation | | +| AzureRm | Used primarily for the AzureRM modules | +| Backup | | | Build | | -| Deployment | Deploy is used somewhat less often | +| ChatOps | | | Cloud | | +| Color | | +| Configuration | | +| CrescendoBuilt | This tag is added automatically by Crescendo when you export the module | +| Database | Databases (plural) is less desirable | +| DBA | | +| Deployment | Deploy is used somewhat less often | +| DevOps | | +| DNS | | +| Docker | | +| DSC | DesiredStateConfiguration is less desirable, it's too long | +| DSCResource | | +| DSCResourceKit | | +| Excel | | +| Exchange | | +| Firewall | | | GIT | | -| Test | Testing is less desirable | -| VersionControl | Version is less precise, although used more frequently | -| Logging | Preferred use of logging as an action | -| Log | Preferred use of Log as a thing | -| Backup | | +| GitHub | | +| Gitlab | | +| Google | | +| HTML | | +| Hyper-V | HyperV is less common as a tag | | IaaS | | -| Linux | | | IIS | | -| AzureAutomation | | -| Storage | | -| GitHub | | | Json | | -| Exchange | | -| Network | Networking is similar, less often used | -| SharePoint | | -| Reporting | Reporting is an action, report is a thing | -| Report | Report is a thing | -| WinRM | | +| Linux | | +| Log | Preferred use of Log as a thing | +| Logging | Preferred use of logging as an action | +| MacOS | | | Monitoring | | -| VSTS | | -| Excel | | -| Google | | -| Color | | -| DNS | | +| MSI | | +| Network | Networking is similar, less often used | | Office365 | Spelling out Office is preferable. O365 is less commonly used, although shorter | -| Gitlab | | -| Pester | | -| AzureAD | | -| HTML | | -| Hyper-V | HyperV is less common as a tag | -| Configuration | | -| ChatOps | | | PackageManagement | | +| Pester | | +| PoshBot | | +| Report | Report is a thing | +| Reporting | Reporting is an action, report is a thing | +| ResourceManager | "Arm" is used to describe group of processors, and shouldn't be used for Azure Resource Manager | +| REST | | +| Security | Defense is less precise | +| SharePoint | | +| SQL | | +| SQLServer | | +| Storage | | +| Test | Testing is less desirable | +| VersionControl | Version is less precise, although used more frequently | +| VSTS | | +| Windows | | +| WinRM | | | WMI | | -| Firewall | | -| Docker | | -| Appveyor | | -| AzureRm | Used primarily for the AzureRM modules | | Zip | | -| MSI | | -| MacOS | | -| PoshBot | | [1]: xref:Microsoft.PowerShell.Core.New-ModuleManifest diff --git a/reference/docs-conceptual/gallery/toc.yml b/reference/docs-conceptual/gallery/toc.yml new file mode 100644 index 000000000000..a2af16308fe2 --- /dev/null +++ b/reference/docs-conceptual/gallery/toc.yml @@ -0,0 +1,95 @@ +items: + - name: PowerShell Gallery + items: + - name: Overview + href: overview.md + - name: Installing PowerShellGet + href: installing-psget.md + - name: Installing PowerShellGet on older systems + href: install-on-older-systems.md + - name: Getting Started + href: getting-started.md + - name: How-To + items: + - name: Finding Packages in the Gallery + items: + - name: Searching For Packages + href: how-to/finding-packages/search-syntax.md + - name: Searching by Compatibility + href: how-to/finding-packages/searching-by-compatibility.md + - name: Filtering Search Results + href: how-to/finding-packages/filtering-packages.md + - name: Publishing to the Gallery + items: + - name: Creating and publishing Packages + href: how-to/publishing-packages/publishing-a-package.md + - name: Creating a PowerShellGallery Account + href: how-to/publishing-packages/creating-an-account.md + - name: Unlisting Packages + href: how-to/publishing-packages/unlisting-packages.md + - name: Deleting Packages + href: how-to/publishing-packages/deleting-packages.md + - name: Managing Packages owners + href: how-to/publishing-packages/managing-package-owners.md + - name: Working with Packages + items: + - name: FileList view + href: how-to/working-with-packages/filelist-view.md + - name: Deploy to Azure Automation + href: how-to/working-with-packages/deploy-to-azure-automation.md + - name: Manual Package Download + href: how-to/working-with-packages/manual-download.md + - name: Packages that Require License Acceptance + href: how-to/working-with-packages/packages-that-require-license-acceptance.md + - name: Contacting Packages owners + href: how-to/working-with-packages/contacting-package-owners.md + - name: Managing Account Profile + items: + - name: PowerShell Gallery Account Settings + href: how-to/managing-profile/managing-account.md + - name: Managing API Keys + href: how-to/managing-profile/creating-apikeys.md + - name: Working with Private PowerShellGet Repositories + href: how-to/working-with-local-psrepositories.md + - name: Concepts + items: + - name: Publishing guidelines and best practices + href: concepts/publishing-guidelines.md + - name: Package manifests and Gallery UI + href: concepts/package-manifest-affecting-ui.md + - name: Requiring Specific PSEditions + items: + - name: Writing Scripts with PSEditions Support + href: concepts/script-psedition-support.md + - name: Writing Modules with PSEdition support + href: concepts/module-psedition-support.md + - name: Requiring License Acceptance + items: + - name: Requiring License Acceptance for Scripts + href: concepts/script-license-acceptance.md + - name: Requiring License Acceptance for Modules + href: concepts/module-license-acceptance.md + - name: Defining Packages as PreRelease + items: + - name: Defining a Module as PreRelease + href: concepts/module-prerelease-support.md + - name: Defining a Script as PreRelease + href: concepts/script-prerelease-support.md + - name: PSScriptAnalyzer Rule Profile + href: concepts/scriptanalyzer-rule-profile.md + - name: Getting Support + items: + - name: Report Abuse + href: how-to/getting-support/report-abuse.md + - name: Dispute resolution + href: how-to/getting-support/dispute-resolution.md + - name: Contacting administrators + href: how-to/getting-support/contacting-administrators.md + - name: Troubleshooting + href: how-to/getting-support/troubleshooting-cmdlets.md + - name: Bootstrapping NuGet provider and NuGet.exe + href: how-to/getting-support/bootstrapping-nuget.md + - name: GDPR Compliance + href: how-to/getting-support/gdpr-dsr-policy.md + - name: Gallery FAQs + href: faqs.yml diff --git a/reference/docs-conceptual/toc.yml b/reference/docs-conceptual/toc.yml index e9763445960e..202e0b8c25b9 100644 --- a/reference/docs-conceptual/toc.yml +++ b/reference/docs-conceptual/toc.yml @@ -408,100 +408,6 @@ items: href: community/2020-updates.md - name: Digital art href: community/digital-art.md - - name: PowerShell Gallery - items: - - name: Overview - href: gallery/overview.md - - name: Installing PowerShellGet - href: gallery/installing-psget.md - - name: Installing PowerShellGet on older systems - href: gallery/install-on-older-systems.md - - name: Getting Started - href: gallery/getting-started.md - - name: How-To - items: - - name: Finding Packages in the Gallery - items: - - name: Searching For Packages - href: gallery/how-to/finding-packages/search-syntax.md - - name: Searching by Compatibility - href: gallery/how-to/finding-packages/searching-by-compatibility.md - - name: Filtering Search Results - href: gallery/how-to/finding-packages/filtering-packages.md - - name: Publishing to the Gallery - items: - - name: Creating and publishing Packages - href: gallery/how-to/publishing-packages/publishing-a-package.md - - name: Creating a PowerShellGallery Account - href: gallery/how-to/publishing-packages/creating-an-account.md - - name: Unlisting Packages - href: gallery/how-to/publishing-packages/unlisting-packages.md - - name: Deleting Packages - href: gallery/how-to/publishing-packages/deleting-packages.md - - name: Managing Packages owners - href: gallery/how-to/publishing-packages/managing-package-owners.md - - name: Working with Packages - items: - - name: FileList view - href: gallery/how-to/working-with-packages/filelist-view.md - - name: Deploy to Azure Automation - href: gallery/how-to/working-with-packages/deploy-to-azure-automation.md - - name: Manual Package Download - href: gallery/how-to/working-with-packages/manual-download.md - - name: Packages that Require License Acceptance - href: gallery/how-to/working-with-packages/packages-that-require-license-acceptance.md - - name: Contacting Packages owners - href: gallery/how-to/working-with-packages/contacting-package-owners.md - - name: Managing Account Profile - items: - - name: PowerShell Gallery Account Settings - href: gallery/how-to/managing-profile/managing-account.md - - name: Managing API Keys - href: gallery/how-to/managing-profile/creating-apikeys.md - - name: Working with Private PowerShellGet Repositories - href: gallery/how-to/working-with-local-psrepositories.md - - name: Concepts - items: - - name: Publishing guidelines and best practices - href: gallery/concepts/publishing-guidelines.md - - name: Packages manifest and Gallery UI - href: gallery/concepts/package-manifest-affecting-ui.md - - name: Requiring Specific PSEditions - items: - - name: Writing Scripts with PSEditions Support - href: gallery/concepts/script-psedition-support.md - - name: Writing Modules with PSEdition support - href: gallery/concepts/module-psedition-support.md - - name: Requiring License Acceptance - items: - - name: Requiring License Acceptance for Scripts - href: gallery/concepts/script-license-acceptance.md - - name: Requiring License Acceptance for Modules - href: gallery/concepts/module-license-acceptance.md - - name: Defining Packages as PreRelease - items: - - name: Defining a Module as PreRelease - href: gallery/concepts/module-prerelease-support.md - - name: Defining a Script as PreRelease - href: gallery/concepts/script-prerelease-support.md - - name: PSScriptAnalyzer Rule Profile - href: gallery/concepts/scriptanalyzer-rule-profile.md - - name: Getting Support - items: - - name: Report Abuse - href: gallery/how-to/getting-support/report-abuse.md - - name: Dispute resolution - href: gallery/how-to/getting-support/dispute-resolution.md - - name: Contacting administrators - href: gallery/how-to/getting-support/contacting-administrators.md - - name: Troubleshooting - href: gallery/how-to/getting-support/troubleshooting-cmdlets.md - - name: Bootstrapping NuGet provider and NuGet.exe - href: gallery/how-to/getting-support/bootstrapping-nuget.md - - name: GDPR Compliance - href: gallery/how-to/getting-support/gdpr-dsr-policy.md - - name: Gallery FAQs - href: gallery/faqs.yml - name: Scripting and development items: - name: Visual Studio Code