Skip to content
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

Update freshness #152

Merged
merged 3 commits into from
Jun 28, 2023
Merged
Show file tree
Hide file tree
Changes from 2 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
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Handling errors in Crescendo
description: This article describes how to handle native command errors in your Crescendo output handler.
ms.date: 04/06/2023
ms.date: 06/28/2023
title: Handling errors in Crescendo
---
# Handling errors in Crescendo

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Transforming arguments in Crescendo
description: This article describes how to transform arguments from the input format to the format needed by the native command.
ms.date: 04/06/2023
ms.date: 06/28/2023
title: Transforming arguments in Crescendo
---
# Transforming arguments in Crescendo

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
description: This article provides examples for using the Crescendo cmdlets to create a configuration. This can be used as an alternate for manually created the JSON configuration file.
ms.date: 12/14/2022
ms.date: 06/28/2023
title: Create a Crescendo configuration using the Crescendo cmdlets
---
# Create a Crescendo configuration using the Crescendo cmdlets
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
description: How to select a command-line tool to amplify using Crescendo.
ms.date: 03/08/2022
ms.date: 06/28/2023
title: Choosing a command-line tool to amplify
---
# Choosing the command-line tool for Crescendo
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
description: How to create a Crescendo cmdlet.
ms.date: 12/14/2022
ms.date: 06/28/2023
title: Create a Crescendo cmdlet
---
# Create a Crescendo cmdlet
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
description: How to generate a Crescendo module from a configuration.
ms.date: 03/09/2022
ms.date: 06/28/2023
title: Generate and test a Crescendo module
---
# Generate and test a Crescendo module
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
description: How to install the Crescendo module.
ms.date: 03/12/2022
ms.date: 06/28/2023
title: Installing Crescendo
---
# Install the Crescendo module
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
description: How to collect information about the command-line tool to decide which features to implement in your cmdlets.
ms.date: 03/07/2022
ms.date: 06/28/2023
title: Research the command-line tool's syntax and output
---
# Research the command-line tool's syntax and output
Expand Down
19 changes: 9 additions & 10 deletions reference/docs-conceptual/Crescendo/overview.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
description: Overview of the Crescendo module
ms.date: 03/07/2022
ms.date: 06/28/2023
title: Crescendo overview
---
# Microsoft.PowerShell.Crescendo overview
Expand Down Expand Up @@ -40,14 +40,13 @@ The documentation for Crescendo includes some new terminology.
### The Crescendo configuration file schema

When you author a Crescendo configuration file, you're writing JSON. For convenience,validation, and
michaeltlombardi marked this conversation as resolved.
Show resolved Hide resolved
an improved developer experience, a
[schema file is available][crescendo-schema].
an improved developer experience, a [schema file is available][01].

You can review the schema to see the required and optional configuration
settings, their descriptions, and the value types they accept. When you
[author your configuration file in Visual Studio Code][vscode-json],
you get numerous helpful features, including IntelliSense, validation while you
edit, and more.
You can review the schema to see the required and optional configuration settings, their
descriptions, and the value types they accept. When you author your configuration file in
[Visual Studio Code][02], you get numerous helpful features, including IntelliSense, validation
while you edit, and more.

[crescendo-schema]: https://aka.ms/PowerShell/Crescendo/Schemas/2021-11
[vscode-json]: https://code.visualstudio.com/Docs/languages/json
<!-- link references -->
[01]: https://aka.ms/PowerShell/Crescendo/Schemas/2021-11
[02]: https://code.visualstudio.com/Docs/languages/json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: What's new in Crescendo 1.1
description: New features and changes released in Crescendo 1.1
ms.date: 04/05/2023
ms.date: 06/28/2023
title: What's new in Crescendo 1.1
---
# What's new in Crescendo 1.1

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: Align assignment statement
ms.custom: PSSA v1.21.0
ms.date: 10/18/2021
ms.date: 06/28/2023
ms.topic: reference
title: AlignAssignmentStatement
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: Changing automatic variables might have undesired side effects
ms.custom: PSSA v1.21.0
ms.date: 10/18/2021
ms.date: 06/28/2023
ms.topic: reference
title: AvoidAssignmentToAutomaticVariable
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: Avoid Default Value For Mandatory Parameter
ms.custom: PSSA v1.21.0
ms.date: 10/18/2021
ms.date: 06/28/2023
ms.topic: reference
title: AvoidDefaultValueForMandatoryParameter
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: Switch Parameters Should Not Default To True
ms.custom: PSSA v1.21.0
ms.date: 10/18/2021
ms.date: 06/28/2023
ms.topic: reference
title: AvoidDefaultValueSwitchParameter
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: Avoid global aliases.
ms.custom: PSSA v1.21.0
ms.date: 10/18/2021
ms.date: 06/28/2023
ms.topic: reference
title: AvoidGlobalAliases
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: Avoid global functions and aliases
ms.custom: PSSA v1.21.0
ms.date: 10/18/2021
ms.date: 06/28/2023
ms.topic: reference
title: AvoidGlobalFunctions
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: No Global Variables
ms.custom: PSSA v1.21.0
ms.date: 10/18/2021
ms.date: 06/28/2023
ms.topic: reference
title: AvoidGlobalVars
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: Avoid Invoking Empty Members
ms.custom: PSSA v1.21.0
ms.date: 10/18/2021
ms.date: 06/28/2023
ms.topic: reference
title: AvoidInvokingEmptyMembers
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: Avoid long lines
ms.custom: PSSA v1.21.0
ms.date: 10/18/2021
ms.date: 06/28/2023
ms.topic: reference
title: AvoidLongLines
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: Avoid multiple type specifiers on parameters.
ms.custom: PSSA v1.21.0
ms.date: 10/18/2021
ms.date: 06/28/2023
ms.topic: reference
title: AvoidMultipleTypeAttributes
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: Avoid using null or empty HelpMessage parameter attribute.
ms.custom: PSSA v1.21.0
ms.date: 10/18/2021
ms.date: 06/28/2023
ms.topic: reference
title: AvoidNullOrEmptyHelpMessageAttribute
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: Avoid overwriting built in cmdlets
ms.custom: PSSA v1.21.0
ms.date: 10/18/2021
ms.date: 06/28/2023
ms.topic: reference
title: AvoidOverwritingBuiltInCmdlets
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: Avoid semicolons as line terminators
ms.custom: PSSA v1.21.0
ms.date: 06/15/2022
ms.date: 06/28/2023
ms.topic: reference
title: AvoidSemicolonsAsLineTerminators
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: Avoid Using ShouldContinue Without Boolean Force Parameter
ms.custom: PSSA v1.21.0
ms.date: 10/18/2021
ms.date: 06/28/2023
ms.topic: reference
title: AvoidShouldContinueWithoutForce
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: Avoid trailing whitespace
ms.custom: PSSA v1.21.0
ms.date: 10/18/2021
ms.date: 06/28/2023
ms.topic: reference
title: AvoidTrailingWhitespace
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: Avoid using broken hash algorithms
ms.custom: PSSA v1.21.0
ms.date: 05/31/2022
ms.date: 06/28/2023
ms.topic: reference
title: AvoidUsingBrokenHashAlgorithms
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: Avoid Using Cmdlet Aliases or omitting the 'Get-' prefix.
ms.custom: PSSA v1.21.0
ms.date: 10/18/2021
ms.date: 06/28/2023
ms.topic: reference
title: AvoidUsingCmdletAliases
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: Avoid Using ComputerName Hardcoded
ms.custom: PSSA v1.21.0
ms.date: 10/18/2021
ms.date: 06/28/2023
ms.topic: reference
title: AvoidUsingComputerNameHardcoded
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: Avoid Using SecureString With Plain Text
ms.custom: PSSA v1.21.0
ms.date: 10/18/2021
ms.date: 06/28/2023
ms.topic: reference
title: AvoidUsingConvertToSecureStringWithPlainText
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: Avoid Using Deprecated Manifest Fields
ms.custom: PSSA v1.21.0
ms.date: 10/18/2021
ms.date: 06/28/2023
ms.topic: reference
title: AvoidUsingDeprecatedManifestFields
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: Avoid using double quotes if the string is constant.
ms.custom: PSSA v1.21.0
ms.date: 10/18/2021
ms.date: 06/28/2023
ms.topic: reference
title: AvoidUsingDoubleQuotesForConstantString
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: Avoid Using Empty Catch Block
ms.custom: PSSA v1.21.0
ms.date: 10/18/2021
ms.date: 06/28/2023
ms.topic: reference
title: AvoidUsingEmptyCatchBlock
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: Avoid Using Invoke-Expression
ms.custom: PSSA v1.21.0
ms.date: 10/18/2021
ms.date: 06/28/2023
ms.topic: reference
title: AvoidUsingInvokeExpression
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: Avoid Using Plain Text For Password Parameter
ms.custom: PSSA v1.21.0
ms.date: 10/18/2021
ms.date: 06/28/2023
ms.topic: reference
title: AvoidUsingPlainTextForPassword
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: Avoid Using Positional Parameters
ms.custom: PSSA v1.21.0
ms.date: 10/18/2021
ms.date: 06/28/2023
ms.topic: reference
title: AvoidUsingPositionalParameters
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: Avoid Using Username and Password Parameters
ms.custom: PSSA v1.21.0
ms.date: 10/18/2021
ms.date: 06/28/2023
ms.topic: reference
title: AvoidUsingUsernameAndPasswordParams
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: Avoid Using Get-WMIObject, Remove-WMIObject, Invoke-WmiMethod, Register-WmiEvent, Set-WmiInstance
ms.custom: PSSA v1.21.0
ms.date: 10/18/2021
ms.date: 06/28/2023
ms.topic: reference
title: AvoidUsingWMICmdlet
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: Avoid Using Write-Host
ms.custom: PSSA v1.21.0
ms.date: 10/18/2021
ms.date: 06/28/2023
ms.topic: reference
title: AvoidUsingWriteHost
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: DSC examples are present
ms.custom: PSSA v1.21.0
ms.date: 10/18/2021
ms.date: 06/28/2023
ms.topic: reference
title: DSCDscExamplesPresent
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: Dsc tests are present
ms.custom: PSSA v1.21.0
ms.date: 10/18/2021
ms.date: 06/28/2023
ms.topic: reference
title: DSCDscTestsPresent
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: Return Correct Types For DSC Functions
ms.custom: PSSA v1.21.0
ms.date: 10/18/2021
ms.date: 06/28/2023
ms.topic: reference
title: DSCReturnCorrectTypesForDSCFunctions
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: Use Standard Get/Set/Test TargetResource functions in DSC Resource
ms.custom: PSSA v1.21.0
ms.date: 10/18/2021
ms.date: 06/28/2023
ms.topic: reference
title: DSCStandardDSCFunctionsInResource
---
Expand Down
Loading