From fc701bfd6a992bb074671b91ac89b50a79d3dc3d Mon Sep 17 00:00:00 2001 From: Jan Larwig Date: Sun, 31 Mar 2024 03:48:07 +0200 Subject: [PATCH] docs/fix-go-install-instruction (#2578) * docs/fix-go-install-instruction * use correct tense --- README.md | 3 ++- docs/docs/installation.md | 3 ++- docs/versioned_docs/version-7.5.x/installation.md | 3 ++- docs/versioned_docs/version-7.6.x/installation.md | 3 ++- 4 files changed, 8 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index d5b05b6f..d0de784e 100644 --- a/README.md +++ b/README.md @@ -28,8 +28,9 @@ Going forward, all images shall be available at `quay.io/oauth2-proxy/oauth2-pro b. Using Go to install the latest release ```bash $ go install github.com/oauth2-proxy/oauth2-proxy/v7@latest - # which will put the binary in `$GOROOT/bin` ``` + This will install the binary into `$GOPATH/bin`. Make sure you include `$GOPATH` in your `$PATH`. Otherwise your system won't find binaries installed via `go install` + c. Using a [Prebuilt Docker Image](https://quay.io/oauth2-proxy/oauth2-proxy) (AMD64, PPC64LE, ARMv6, ARMv7, and ARM64 available) d. Using a [Pre-Release Nightly Docker Image](https://quay.io/oauth2-proxy/oauth2-proxy-nightly) (AMD64, PPC64LE, ARMv6, ARMv7, and ARM64 available) diff --git a/docs/docs/installation.md b/docs/docs/installation.md index dc9b6b1b..522bfab9 100644 --- a/docs/docs/installation.md +++ b/docs/docs/installation.md @@ -10,8 +10,9 @@ title: Installation b. Using Go to install the latest release ```bash $ go install github.com/oauth2-proxy/oauth2-proxy/v7@latest - # which will put the binary in `$GOROOT/bin` ``` + This will install the binary into `$GOPATH/bin`. Make sure you include `$GOPATH` in your `$PATH`. Otherwise your system won't find binaries installed via `go install` + c. Using a [Prebuilt Docker Image](https://quay.io/oauth2-proxy/oauth2-proxy) (AMD64, PPC64LE, ARMv6, ARMv7, and ARM64 available) d. Using a [Pre-Release Nightly Docker Image](https://quay.io/oauth2-proxy/oauth2-proxy-nightly) (AMD64, PPC64LE, ARMv6, ARMv7, and ARM64 available) diff --git a/docs/versioned_docs/version-7.5.x/installation.md b/docs/versioned_docs/version-7.5.x/installation.md index 3720853b..6386b896 100644 --- a/docs/versioned_docs/version-7.5.x/installation.md +++ b/docs/versioned_docs/version-7.5.x/installation.md @@ -11,8 +11,9 @@ slug: / b. Using Go to install the latest release ```bash $ go install github.com/oauth2-proxy/oauth2-proxy/v7@latest - # which will put the binary in `$GOROOT/bin` ``` + This will install the binary into `$GOPATH/bin`. Make sure you include `$GOPATH` in your `$PATH`. Otherwise your system won't find binaries installed via `go install` + c. Using a [Prebuilt Docker Image](https://quay.io/oauth2-proxy/oauth2-proxy) (AMD64, PPC64LE, ARMv6, ARMv7, and ARM64 available) d. Using a [Pre-Release Nightly Docker Image](https://quay.io/oauth2-proxy/oauth2-proxy-nightly) (AMD64, PPC64LE, ARMv6, ARMv7, and ARM64 available) diff --git a/docs/versioned_docs/version-7.6.x/installation.md b/docs/versioned_docs/version-7.6.x/installation.md index dc9b6b1b..522bfab9 100644 --- a/docs/versioned_docs/version-7.6.x/installation.md +++ b/docs/versioned_docs/version-7.6.x/installation.md @@ -10,8 +10,9 @@ title: Installation b. Using Go to install the latest release ```bash $ go install github.com/oauth2-proxy/oauth2-proxy/v7@latest - # which will put the binary in `$GOROOT/bin` ``` + This will install the binary into `$GOPATH/bin`. Make sure you include `$GOPATH` in your `$PATH`. Otherwise your system won't find binaries installed via `go install` + c. Using a [Prebuilt Docker Image](https://quay.io/oauth2-proxy/oauth2-proxy) (AMD64, PPC64LE, ARMv6, ARMv7, and ARM64 available) d. Using a [Pre-Release Nightly Docker Image](https://quay.io/oauth2-proxy/oauth2-proxy-nightly) (AMD64, PPC64LE, ARMv6, ARMv7, and ARM64 available)