From 1aa062b37b5c78efacc3a17bbae3db612e332a58 Mon Sep 17 00:00:00 2001 From: Kenneth Jenkins <51246568+kenjenkins@users.noreply.github.com> Date: Mon, 15 Apr 2024 14:03:38 -0700 Subject: [PATCH] update README: link to Contributing page (#5072) Remove the inline integration test instructions in favor of a link to the Contributing page on the documentation site. Remove some unused link definitions and update the godoc.org link to use pkg.go.dev instead. --- README.md | 34 +++++----------------------------- 1 file changed, 5 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index dd958ca7b..10820bd48 100644 --- a/README.md +++ b/README.md @@ -19,34 +19,10 @@ It’s not a VPN alternative – it’s the trusted, foolproof way to protect yo For comprehensive docs, and tutorials see our [documentation]. -[documentation]: https://pomerium.com/docs/ -[go environment]: https://golang.org/doc/install -[godocs]: https://godoc.org/github.com/pomerium/pomerium -[quick start guide]: https://www.pomerium.com/docs/install/quickstart +## Contributing -## Integration Tests +See [Contributing] for information on how you can contribute to Pomerium. -To run the integration tests locally, first build a local development image: - -```bash -./scripts/build-dev-docker.bash -``` - -Next go to the `integration/clusters` folder and pick a cluster, for example `google-single`, then use docker-compose to start the cluster. We use an environment variable to specify the `dev` docker image we built earlier: - -```bash -cd integration/clusters/google-single -env POMERIUM_TAG=dev docker-compose up -V -``` - -Once that's up and running you can run the integration tests from another terminal: - -```bash -go test -count=1 -v ./integration/... -``` - -If you need to make a change to the clusters themselves, there's a `tpl` folder that contains `jsonnet` files. Make a change and then rebuild the clusters by running: - -```bash -go run ./integration/cmd/pomerium-integration-tests/ generate-configuration -``` +[contributing]: https://www.pomerium.com/docs/community/contributing +[documentation]: https://www.pomerium.com/docs/ +[godocs]: https://pkg.go.dev/github.com/pomerium/pomerium