From f64779cba784c4ea573d8cd7ff42a5850a57ce30 Mon Sep 17 00:00:00 2001 From: Ryan Richard Date: Fri, 18 Mar 2022 14:27:33 -0700 Subject: [PATCH] small updates to CONTRIBUTING.md --- CONTRIBUTING.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ddef26d0..1351b6b5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 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 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: ```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