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

Tweak docs to match new TUI output #27

Merged
merged 1 commit into from
Apr 14, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This project is written in Go and uses `make` for task running. Code should be f
You can build Canary into `./bin/canary` with:

```shell
$ make
$ make build
go build -o bin/canary .
```

Expand Down
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,12 +131,12 @@ We can then run our specification against any desired container image to see a p
```console
$ canary validate --file examples/kubeflow.yaml public.ecr.aws/j1r0q0g6/notebooks/notebook-servers/jupyter-scipy:v1.5.0-rc.1
Validating public.ecr.aws/j1r0q0g6/notebooks/notebook-servers/jupyter-scipy:v1.5.0-rc.1 against kubeflow
👩 User is jovyan [true]
🆔 User ID is 1000 [true]
🏠 Home directory is /home/jovyan [true]
🌏 Exposes an HTTP interface on port 8888 [true]
🧭 Correctly routes the NB_PREFIX [true]
🔓 Sets 'Access-Control-Allow-Origin: *' header [true]
👩 User is jovyan [passed]
🆔 User ID is 1000 [passed]
🏠 Home directory is /home/jovyan [passed]
🌏 Exposes an HTTP interface on port 8888 [passed]
🧭 Correctly routes the NB_PREFIX [passed]
🔓 Sets 'Access-Control-Allow-Origin: *' header [passed]
validation passed
```

Expand Down