platyPS icon indicating copy to clipboard operation
platyPS copied to clipboard

Meta-issue for tracking v2 release

Open sdwheeler opened this issue 3 years ago • 0 comments

Summary of the new feature / enhancement

Subject Issue Title 2.0-Preview2 2.0-Preview3 Build Improvements Future-Consider Future-Localization
Build #432 Optimize build.ps1 to use $PSScriptRoot instead of relying on PWD 1
#479 build.ps1 forces you to close & re-open PowerShell to re-build 1
#498 Need to rework Pester tests to test against static content 1
#500 Build script fails on errors from Pester and Update-Help 1
CDXML #262 Auto file naming should handle cdxml better 1
Comment-based help #224 Error handling links to other commands 1
#373 Add support for Functionality & Component help sections 1
#487 Parsing Examples fixed to 1 line of code? 1
#503 Prompt is being removed from first line of a multiple line example 1
#558 Documenting Outputs/Inputs (with Descriptions) in Code 1
Localization #436 Local languages not supported 1
#484 PlatyPS doesn't support localized headers. 1
#535 V2 move schema template strings to RESX to allow for localization 1
Merge-MarkdownHelp #337 Merge-MarkdownHelp munges multiple syntax blocks together 1
#511 Merge-MarkdownHelp expectation when parameter type varies across versions? 1
New-ExternalHelp #222 Markdown chars in generated help.txt file 2
#401 Missing command:syntaxItem in the output maml file 1
#408 Valid markdown line ends are causing markdown -> maml convertion error 1
#429 Loss of carriage return issues for MD to MAML and then back to MD 1
#472 Code blocks not allowed in DESCRIPTION 1
#480 New-ExternalHelp not handling escaped characters correctly 1
#492 New-ExternalHelp should handle "markdown lists" in "Related Links" section 1
#508 New-ExternalHelp removes specific carriage returns 1
#541 Rendering issue with Get-ChildItem -Include and -Exclude parameters 1
#553 New-ExternalHelp is not including all remarks for an example 1
#559 PlatyPS v2 needs to support OPS markdown extensions 1
New-MarkdownAboutHelp #229 New-MarkdownAboutHelp doesn't create intermediate directories 1
#367 New-MarkdownAboutHelp - make easier to migrate exiting files to the markdown format help 1
New-MarkdownHelp #106 cmdlets renaming handled poorly 1
#111 Need a solution to generate Provider topics 1
#128 Add Aliases to the Cmdlet Reference MD 1
#245 PlatyPS needs to create help for dynamic parameters 1
#250 Provide Related Links template 1
#252 Need options for creating ModulePage 1
#264 Example code should not start with 'PS C:>' 1
#351 Escape commas of parameter accepted values 1
#363 Syntax sections notation intermittent issue 1
#388 Generate Help from Module Manifest psd1 file 1
#389 Generate Help From Publish-able powershell script 1
#394 PlatyPS should support creating documentation for DSC Resources 1
#407 New-MarkdownHelp example 1 fails if executed within script 1
#453 WithModulePage extra information 1
#457 ModulePage in v0.13.0 introduces new verbiage in output 1
#464 HelpMessage of binary cmdlet 1
#476 Transformer skips default parameter set 1
#483 Need to support dynamic parameters 1
#491 What is considered a default value? 1
#495 MarkdownLint - Improve output by fixing MD022 and MD040 1
#501 Maintain parameter order 1
#506 New-MarkdownHelp returns error when generating markdown when document already exists 1
#509 New-MarkdownHelp 0.14.1 generates bogus errors when using the Session parameter. 1
#518 Incorrect Syntax generated for Parameters with multiple Positions 1
#519 Generic type generated by PlatyPS in markdown is not expected 1
#543 Mandatory parameters are generated inconsistently 1
#544 New-MarkdownHelp generates MD triggering Code scanning rule: "remark-lint-no-literal-urls" 1
#545 New-MarkdownHelp v2 does not generate InputType for Set-AzDataLakeAnalyticsAccount 1
#550 PlatyPS should create the title: metadata value in the markdown file 1
#560 Should platyPS support/document Validation Sets? 1
New-YamlHelp #481 YamlDotNet - Assembly with same name is already loaded 1
#540 CommonParameters block not included in YAML output 1
#564 Add YAML metadata to front matter to identify preview modules 1
Quality #108 Cmdlet Design Review notes 1
#421 Platyps log files is incorrect for Update-Markdown activity 1
#442 Empty file causes errors 1
#451 Links in the ModulePage does not work when used -ModulePagePath in a different folder 1
#65 New cmdlet Test-Markdown 1
Release plan #537 Update cmdlets for V2, New-YamlHelp, Update-MarkdownHelp, Update-MarkdownHelpModule 1
#538 Update cmdlets for V2, New-ExternalHelp, New-ExternalHelpCab 1
#539 Update cmdlets for V2, Merge-MarkdownHelp, Get-HelpPreview 1
Update-MarkdownHelp #170 Support for -WhatIf 1
#230 Update-MarkdownHelp is generating inappropriate errors for end-user 1
#292 Update-MarkdownHelp should preserve original formatting 1
#294 Add "powershell" label to examples markdown 1
#315 Update-MarkdownHelp should support multiple threads to speed up large projects 1
#375 Why doesn't Update-MarkdownHelpModule have the UseFullTypeName switch 1
#385 Update-MarkdownHelpModule should not require dashes in all cmdlet names 1
#419 Update-MarkdownHelp does not merge YAML block for parameter 1
#420 Update-MarkdownHelp overwrites existing descriptions for Common Parameters, Input, and Output 1
#430 Update-MarkdownHelpModule always adds <CommonParameters> to Syntax even when [CmdletBinding()] is not there 1
#494 Update-MarkdownHelp does not update placeholders "{{ }}" once Parameters have been described in the Function 1
#554 Cannot support hyphen in language identifier of code block 1
Usability #336 platyPS workflow doesn't support configuration 1
#99 Add Show-HelpPreview -MarkdownFile <string[]> parameterSet 1
v2 bug #521 V2 implementation does not consider ExternalScriptInfo 1
#530 V2 Invalid output generated with v2 - Exception calling "NodeModelToMamlModel" with "1" argument(s) 1
#533 V2 Related links section has improper information 1
Grand Total 14 24 4 42 3

Proposed technical implementation details (optional)

No response

sdwheeler avatar Apr 11 '22 19:04 sdwheeler