MicrosoftDocs / PowerShell-Docs-DSC

Documentation for PowerShell Desired State Configuration
https://learn.microsoft.com/powershell/dsc/overview
Creative Commons Attribution 4.0 International
31 stars 36 forks source link

(MAINT) Fix rendering for YAML metadata #182

Closed michaeltlombardi closed 1 year ago

michaeltlombardi commented 1 year ago

PR Summary

Prior to this change, the metadata YAML blocks for schemas and CLI parameters included spaces in the keyword names, aligned colons, and used block syntax.

The platform does not render keywords correctly when they include spaces or when there is space between the keyword and the colon.

This change standardizes the formatting so that keywords are correctly highlighted. It also switches to using flow syntax for arrays, keeping them on one line if the array fits or breaking across indented lines otherwise.

PR Checklist

learn-build-service-prod[bot] commented 1 year ago

Learn Build status updates of commit afa8c9e:

:white_check_mark: Validation status: passed

File Status Preview URL Details
dsc/docs-conceptual/dsc-3.0/reference/cli/dsc.md :white_check_mark:Succeeded View (dsc-3.0)
dsc/docs-conceptual/dsc-3.0/reference/cli/schema/command.md :white_check_mark:Succeeded View (dsc-3.0)
dsc/docs-conceptual/dsc-3.0/reference/schemas/config/document.md :white_check_mark:Succeeded View (dsc-3.0)
dsc/docs-conceptual/dsc-3.0/reference/schemas/config/parameter.md :white_check_mark:Succeeded View (dsc-3.0)
dsc/docs-conceptual/dsc-3.0/reference/schemas/config/resource.md :white_check_mark:Succeeded View (dsc-3.0)
dsc/docs-conceptual/dsc-3.0/reference/schemas/definitions/message.md :white_check_mark:Succeeded View (dsc-3.0)
dsc/docs-conceptual/dsc-3.0/reference/schemas/definitions/parameters/dataTypes.md :white_check_mark:Succeeded View (dsc-3.0)
dsc/docs-conceptual/dsc-3.0/reference/schemas/definitions/resourceType.md :white_check_mark:Succeeded View (dsc-3.0)
dsc/docs-conceptual/dsc-3.0/reference/schemas/outputs/config/get.md :white_check_mark:Succeeded View (dsc-3.0)
dsc/docs-conceptual/dsc-3.0/reference/schemas/outputs/config/set.md :white_check_mark:Succeeded View (dsc-3.0)
dsc/docs-conceptual/dsc-3.0/reference/schemas/outputs/config/test.md :white_check_mark:Succeeded View (dsc-3.0)
dsc/docs-conceptual/dsc-3.0/reference/schemas/outputs/resource/get.md :white_check_mark:Succeeded View (dsc-3.0)
dsc/docs-conceptual/dsc-3.0/reference/schemas/outputs/resource/list.md :white_check_mark:Succeeded View (dsc-3.0)
dsc/docs-conceptual/dsc-3.0/reference/schemas/outputs/resource/set.md :white_check_mark:Succeeded View (dsc-3.0)
dsc/docs-conceptual/dsc-3.0/reference/schemas/outputs/resource/test.md :white_check_mark:Succeeded View (dsc-3.0)
dsc/docs-conceptual/dsc-3.0/reference/schemas/resource/manifest/get.md :white_check_mark:Succeeded View (dsc-3.0)
dsc/docs-conceptual/dsc-3.0/reference/schemas/resource/manifest/provider.md :white_check_mark:Succeeded View (dsc-3.0)
dsc/docs-conceptual/dsc-3.0/reference/schemas/resource/manifest/root.md :white_check_mark:Succeeded View (dsc-3.0)
dsc/docs-conceptual/dsc-3.0/reference/schemas/resource/manifest/schema/embedded.md :white_check_mark:Succeeded View (dsc-3.0)
dsc/docs-conceptual/dsc-3.0/reference/schemas/resource/manifest/schema/property.md :white_check_mark:Succeeded View (dsc-3.0)
dsc/docs-conceptual/dsc-3.0/reference/schemas/resource/manifest/set.md :white_check_mark:Succeeded View (dsc-3.0)
dsc/docs-conceptual/dsc-3.0/reference/schemas/resource/manifest/test.md :white_check_mark:Succeeded View (dsc-3.0)
dsc/docs-conceptual/dsc-3.0/reference/schemas/resource/manifest/validate.md :white_check_mark:Succeeded View (dsc-3.0)
dsc/docs-conceptual/dsc-3.0/reference/schemas/resource/properties/ensure.md :white_check_mark:Succeeded View (dsc-3.0)
dsc/docs-conceptual/dsc-3.0/reference/schemas/resource/properties/inDesiredState.md :white_check_mark:Succeeded View (dsc-3.0)

This comment lists only the first 25 files in the pull request. For more details, please refer to the build report.

For any questions, please:

learn-build-service-prod[bot] commented 1 year ago

Learn Build status updates of commit 594f59e:

:white_check_mark: Validation status: passed

File Status Preview URL Details
dsc/docs-conceptual/dsc-3.0/reference/cli/dsc.md :white_check_mark:Succeeded View (dsc-3.0)
dsc/docs-conceptual/dsc-3.0/reference/cli/schema/command.md :white_check_mark:Succeeded View (dsc-3.0)
dsc/docs-conceptual/dsc-3.0/reference/schemas/config/document.md :white_check_mark:Succeeded View (dsc-3.0)
dsc/docs-conceptual/dsc-3.0/reference/schemas/config/parameter.md :white_check_mark:Succeeded View (dsc-3.0)
dsc/docs-conceptual/dsc-3.0/reference/schemas/config/resource.md :white_check_mark:Succeeded View (dsc-3.0)
dsc/docs-conceptual/dsc-3.0/reference/schemas/definitions/message.md :white_check_mark:Succeeded View (dsc-3.0)
dsc/docs-conceptual/dsc-3.0/reference/schemas/definitions/parameters/dataTypes.md :white_check_mark:Succeeded View (dsc-3.0)
dsc/docs-conceptual/dsc-3.0/reference/schemas/definitions/resourceType.md :white_check_mark:Succeeded View (dsc-3.0)
dsc/docs-conceptual/dsc-3.0/reference/schemas/outputs/config/get.md :white_check_mark:Succeeded View (dsc-3.0)
dsc/docs-conceptual/dsc-3.0/reference/schemas/outputs/config/set.md :white_check_mark:Succeeded View (dsc-3.0)
dsc/docs-conceptual/dsc-3.0/reference/schemas/outputs/config/test.md :white_check_mark:Succeeded View (dsc-3.0)
dsc/docs-conceptual/dsc-3.0/reference/schemas/outputs/resource/get.md :white_check_mark:Succeeded View (dsc-3.0)
dsc/docs-conceptual/dsc-3.0/reference/schemas/outputs/resource/list.md :white_check_mark:Succeeded View (dsc-3.0)
dsc/docs-conceptual/dsc-3.0/reference/schemas/outputs/resource/set.md :white_check_mark:Succeeded View (dsc-3.0)
dsc/docs-conceptual/dsc-3.0/reference/schemas/outputs/resource/test.md :white_check_mark:Succeeded View (dsc-3.0)
dsc/docs-conceptual/dsc-3.0/reference/schemas/resource/manifest/get.md :white_check_mark:Succeeded View (dsc-3.0)
dsc/docs-conceptual/dsc-3.0/reference/schemas/resource/manifest/provider.md :white_check_mark:Succeeded View (dsc-3.0)
dsc/docs-conceptual/dsc-3.0/reference/schemas/resource/manifest/root.md :white_check_mark:Succeeded View (dsc-3.0)
dsc/docs-conceptual/dsc-3.0/reference/schemas/resource/manifest/schema/embedded.md :white_check_mark:Succeeded View (dsc-3.0)
dsc/docs-conceptual/dsc-3.0/reference/schemas/resource/manifest/schema/property.md :white_check_mark:Succeeded View (dsc-3.0)
dsc/docs-conceptual/dsc-3.0/reference/schemas/resource/manifest/set.md :white_check_mark:Succeeded View (dsc-3.0)
dsc/docs-conceptual/dsc-3.0/reference/schemas/resource/manifest/test.md :white_check_mark:Succeeded View (dsc-3.0)
dsc/docs-conceptual/dsc-3.0/reference/schemas/resource/manifest/validate.md :white_check_mark:Succeeded View (dsc-3.0)
dsc/docs-conceptual/dsc-3.0/reference/schemas/resource/properties/ensure.md :white_check_mark:Succeeded View (dsc-3.0)
dsc/docs-conceptual/dsc-3.0/reference/schemas/resource/properties/inDesiredState.md :white_check_mark:Succeeded View (dsc-3.0)

This comment lists only the first 25 files in the pull request. For more details, please refer to the build report.

For any questions, please: