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

Add powershell instructions for fcct usage #171

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add powershell instructions for fcct usage #171

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions modules/ROOT/pages/using-fcct.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 the Get-Content cmdlet to read the configuration and pass it over a pipe.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree, but let's provide a clear example inside that TIP.

+
.Example running `fcct` using files:
`podman run --rm -v /path/to/your_config.fcc:/config.fcc:z quay.io/coreos/fcct:release --pretty --strict /config.fcc > transpiled_config.ign`
+
Expand Down