Description
Prerequisites
- Existing Issue: Search the existing issues for this repository. If there is an issue that fits your needs do not file a new one. Subscribe, react, or comment on that issue instead.
- Descriptive Title: Write the title for this issue as a short synopsis. If possible, provide context. For example, "Document new
Get-Foo
cmdlet" instead of "New cmdlet."
Summary
# type: feature-request
# category: docs
# duplicate-likelihood: 0.75
# did-a-title-search-beforehand: $true
# urgency: low
# severity: medium
# version: 6536e0a
preface
By and large, Powershell docs are fine. Though somewhat insufficient to get Linux devs enthused, I reckon. Due to prevalence and howto article spam, additional information isn't often easy to get by. Unless you have a local Windows install at hand, plus aptitute for live testing.
example
One area that's most lacking is type information. For example windows-powershell-docs/blob/main/docset/winserver2022-ps/hyper-v/Get-VMNetworkAdapter.md
does enumerate possible result types, but leaves viewers uninformed about what properties any of 'em would entail.
One can't honestly extrapolate property presence nor naming from other cmdlets in a module.
desired doc details
The "OUTPUTS" section in the (autogenerated?) docs shouldn't just list Microsoft.HyperV.PowerShell.VMNetworkAdapter
, but embed a link.
- Ideally it ought to link to another docs page, detailing properties with an examplary example of utmost examplarinies.
- And/or to some source of the pertaining PS module (entirely oblivious if e.g. Hyper-V module is FLOSS).
- Linking to some Cim_Instance documentation is an acceptable (if often more confusing) fallback.
(Found some external samples now, showcasing e.g. mac addresses in the VM network interface object type. Ideally this would be discoverable in official docs however.)
Details
Proposed Content Type
About Topic, Other / Unknown
Proposed Title
Microsoft.HyperV.PowerShell.VMNetworkAdapter type and properties