djpbessems/ContainerImage.Pinniped
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

small updates to CONTRIBUTING.md

Browse Source
This commit is contained in:
Ryan Richard 2022-03-18 14:27:33 -07:00
parent c710cfbc70
commit f64779cba7
1 changed files with 8 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
CONTRIBUTING.md
View File

@ -79,6 +79,13 @@ a Pull Request. For questions about the CLA process, see the
[FAQ](https://cla.vmware.com/faq) or submit a question through the GitHub issue [FAQ](https://cla.vmware.com/faq) or submit a question through the GitHub issue
tracker. tracker.
## Learning about Pinniped
New to Pinniped?
- Start here to learn how to install and use Pinniped: [Learn to use Pinniped for federated authentication to Kubernetes clusters](https://pinniped.dev/docs/tutorials/concierge-and-supervisor-demo/)
- Start here to learn how to navigate the source code: [Code Walk-through](https://pinniped.dev/docs/reference/code-walkthrough/)
- Other more detailed documentation can be found at: [Pinniped Docs](https://pinniped.dev/docs/)
## Building ## Building
The [Dockerfile](Dockerfile) at the root of the repo can be used to build and The [Dockerfile](Dockerfile) at the root of the repo can be used to build and
@ -139,7 +146,7 @@ go build -o pinniped ./cmd/pinniped
1. Run the Pinniped integration tests: 1. Run the Pinniped integration tests:
```bash ```bash
source /tmp/integration-test-env && go test -v -count 1 -timeout 0 ./test/integration ulimit -n 512 && source /tmp/integration-test-env && go test -v -count 1 -timeout 0 ./test/integration
``` ```
1. After making production code changes, recompile, redeploy, and run tests again by repeating the same 1. After making production code changes, recompile, redeploy, and run tests again by repeating the same