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.

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

ifconfig sample creates a poor impression #152

Open
jhoneill opened this issue May 19, 2022 · 6 comments
Open

ifconfig sample creates a poor impression #152

jhoneill opened this issue May 19, 2022 · 6 comments
Assignees
Labels
Documentation-Needed Documentation-Needed Issue-Triaged issue was read and triaged

Comments

@jhoneill
Copy link

  • It has place holders where help should be,
  • It doesn't parse output
  • It simply just turns ifconfig into invoke-ifconfig.

Why would anyone use it ?
Several of the examples appear to turn command into invoke-command with longer parameter names (dd, ls, tar, who) without parsing the output.

@theJasonHelmick theJasonHelmick self-assigned this May 23, 2022
@theJasonHelmick theJasonHelmick added Issue-Triaged issue was read and triaged Documentation-Needed Documentation-Needed labels May 23, 2022
@theJasonHelmick theJasonHelmick added this to the Future-Consider milestone May 23, 2022
@theJasonHelmick
Copy link
Collaborator

Thanks for the feedback @jhoneill. The samples are not intended to be complete solutions, rather samples of a particular feature or task. Having said that, I do agree that they can be improved, including some of the points you mention, to better help folks working with Crescendo.

@jhoneill
Copy link
Author

@theJasonHelmick Yes, understood, but samples shipped with code should be really knock-your-socks-off examples; some of those included are good, and this one, TBH, just isn't.

@JamesWTruher
Copy link
Member

I don't agree that all the samples should be knock-your-socks-off examples. very simple examples should also be present to show a complete story.

@jhoneill
Copy link
Author

@JamesWTruher

YES, simple is good if it tells a story

Functionally this sample can be replaced with new-alias -Name Invoke-IfConfig -Value ifconfig

The json contains
"Description": "This is the description for a parameter",
which just looks like someone isn't trying.

@JamesWTruher
Copy link
Member

I'll update the description.
It doesn't matter if it can be replaced by an alias, that is not the point. It shows that a very simple example is possible.

@theJasonHelmick
Copy link
Collaborator

Thanks James (@jhoneill ). We are all trying. as mentioned, I'll go through and take a look at places we could add additional examples and improvements in a future milestone.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation-Needed Documentation-Needed Issue-Triaged issue was read and triaged
Projects
None yet
Development

No branches or pull requests

3 participants