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.

Sign up for GitHub

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

Jump to bottom

PlatyPS not clear that making cab files is a windows only feature #116

Closed
2 tasks done
ehmiiz opened this issue Nov 22, 2022 · 0 comments · Fixed by #117
Closed
2 tasks done

PlatyPS not clear that making cab files is a windows only feature #116

ehmiiz opened this issue Nov 22, 2022 · 0 comments · Fixed by #117
Labels
area-platyps Area - PlatyPS module issue-doc-bug Issue - error in documentation

Comments

@ehmiiz
Copy link

ehmiiz commented Nov 22, 2022

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."

Module

PlatyPS

Summary

When making external help for modules, as a Linux / PowerShell users, it's not that clear that platyps is using MakeCab.exe if reading it's documentation. It would be great if the parameter help would inform you of this.

Details

Screenshot from 2022-11-22 17-06-11
Screenshot from 2022-11-22 17-05-52

Content Type

Cmdlet Reference

Proposed Title

N/A

Related Articles

https://github.com/PowerShell/platyPS/blob/8c3d042fe5e7e6f122f9450970ae4c6b8138f447/docs/New-ExternalHelpCab.md
@ehmiiz ehmiiz added issue-doc-idea Issue - request for new content needs-triage Waiting - Needs triage labels Nov 22, 2022
@michaeltlombardi michaeltlombardi added area-platyps Area - PlatyPS module issue-doc-bug Issue - error in documentation and removed issue-doc-idea Issue - request for new content needs-triage Waiting - Needs triage labels Nov 22, 2022
michaeltlombardi added a commit to michaeltlombardi/PowerShell-Docs-Modules that referenced this issue Nov 22, 2022
@michaeltlombardi
(MicrosoftDocsGH-116) Clarify New-ExternalHelpCab is Windows-only
d9aab51 
Prior to this change, the documentation didn't state that the PlatyPS
cmdlet `New-ExternalHelpCab` only works on Windows, despite requiring
the `MakeCab.exe` native command, which is only available on Windows.

This change adds a notice to the cmdlet documentation to clarify this
limitation.

- Resolves MicrosoftDocs#116
- Fixes AB#41454
@michaeltlombardi michaeltlombardi mentioned this issue Nov 22, 2022
Merged
4 tasks
michaeltlombardi added a commit that referenced this issue Nov 22, 2022
@michaeltlombardi
(GH-116) Clarify New-ExternalHelpCab is Windows-only (#117)
d5cfec3 
Prior to this change, the documentation didn't state that the PlatyPS
cmdlet `New-ExternalHelpCab` only works on Windows, despite requiring
the `MakeCab.exe` native command, which is only available on Windows.

This change adds a notice to the cmdlet documentation to clarify this
limitation.

- Resolves #116
- Fixes AB#41454
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
area-platyps Area - PlatyPS module issue-doc-bug Issue - error in documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

(GH-116) Clarify New-ExternalHelpCab is Windows-only michaeltlombardi/PowerShell-Docs-Modules
2 participants
@michaeltlombardi @ehmiiz