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

Cmdlet PSHelp #14

Closed
romandres opened this issue Sep 30, 2022 · 2 comments · Fixed by #38
Closed

Cmdlet PSHelp #14

romandres opened this issue Sep 30, 2022 · 2 comments · Fixed by #38
Milestone
v1

Comments

@romandres
Copy link
Owner

romandres commented Sep 30, 2022 •
edited
Loading

  • Log Levels
  • RunMode
  • ExpressionTemplate
  • Filtering (FilterIncludeOnlyExpression, FilterExcludeExpression)
  • Output format with Expression Templates
  • EventLog
    • LogName and LogSource
    • Create custom EventLog
    • Event ID provider
  • File logger
    • FileSizeLimit
    • RetainedFileCountLimit
    • RollOnFileSizeLimit
    • RollingInterval
  • App Insights
    • Properties (hashtable)
@romandres romandres added this to the v1 milestone Oct 3, 2022
@romandres romandres changed the title Cmdlet Documentation Cmdlet PSHelp Oct 3, 2022
@romandres
Copy link
Owner Author

Looks like https://github.com/red-gate/XmlDoc2CmdletDoc is a good fit to achieve this with documentation comments.

Detailed guide:
https://www.red-gate.com/simple-talk/development/dotnet-development/documenting-your-powershell-binary-cmdlets/

@romandres
Copy link
Owner Author

XmlDoc2CmdletDoc only works on Windows but since this module is built on an Ubuntu and a Windows system, the documentation can be generated on the latter there.

@romandres romandres mentioned this issue Apr 18, 2023
Merged
@romandres romandres linked a pull request Apr 18, 2023 that will close this issue
v0.9.0 #38
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
v1
Development

Successfully merging a pull request may close this issue.

v0.9.0 romandres/PSStreamLogger
1 participant
@romandres