Add powershell instructions for fcct usage #171
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
benjaminpreiss
changed the title
lucab
reviewed
Sep 9, 2020
| @@ -21,6 +21,9 @@ This example uses podman, but you can use docker in a similar manner. Note that | |||
| .Example running `fcct` using standard in and standard out: | |||
| `podman run -i --rm quay.io/coreos/fcct:release --pretty --strict < your_config.fcc > transpiled_config.ign` | |||
| + | |||
| .Same example as above just for powershell (`<` is a reserved char.): | |||
| `Get-Content your_config.fcc | podman run -i --rm quay.io/coreos/fcct:release --pretty --strict > transpiled_config.ign` | |||
There was a problem hiding this comment.
There are unfortunately a few more places in the docs where we show this stdin redirection, and I don't think it's good to duplicate all the examples. I'd suggest instead to add a TIP at the bottom here with something like:
PowerShell has a different syntax for input redirection, and
<is a reserved character there. Instead, you can use theGet-Contentcmdlet to read the configuration and pass it over a pipe.
There was a problem hiding this comment.
I agree, but let's provide a clear example inside that TIP.
|
@benjaminpreiss Are you still interested in tweaking this PR as suggested above? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In case of using powershell I think it would be very helpful to give people a hint that
<will not work.