citrix / citrix/devdocs-issue-collector
PVS PowerShell - Cmdlet examples poorly formatted, invalid examples, and undocumented functionality
- Dominant language
- No language data
- Stars
- 3
- Forks
- 1
- PR merge metrics
- No merged PRs in 30d
Description
The PVS PowerShell cmdlet examples are very hard to read, the UI of the portal is very troublesome compared to other SDKs documented on the development site, such as the CVAD PowerShell SDK. Please separate cmdlets into different pages in a fashion that matches the documentation other Citrix PowerShell SDKs with better explanation of the input parameters and return values.
Multiple cmdlet examples in the documentation are also broken, for example: https://developer-docs.citrix.com/projects/provisioning-services-powershell-object-programming-guide/en/latest/cmdlets/#example-1-start-pvscreatedisk-for-vhdx-to-pvsdisklocator
This example will not execute in PowerShell and will result in errors.
Lastly, there doesn't appear to be any documentation of the BDM PowerShell SDK in the Developer Portal.
Docs URL:https://developer-docs.citrix.com/projects/provisioning-services-powershell-object-programming-guide/en/latest/cmdlets/
Contributor guide
No contributing guide indexed for this repository
Research direction
Start at the PVS PowerShell cmdlet documentation URL and inspect the linked Start-PVSCreateDisk example, checking which examples fail when run in PowerShell. Done means cmdlets are separated into clearer pages with input and return-value explanations, broken examples are corrected, and BDM PowerShell SDK documentation is added.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- powershell
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100