From 40278b845149be3c04d1eb352b2d81ad491b608e Mon Sep 17 00:00:00 2001 From: rui Date: Thu, 30 Dec 2021 07:59:01 -0500 Subject: [PATCH] docs: update website links (#1964) Signed-off-by: Rui Chen --- runatlantis.io/docs/configuring-webhooks.md | 4 ++-- runatlantis.io/docs/server-configuration.md | 10 +++++----- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/runatlantis.io/docs/configuring-webhooks.md b/runatlantis.io/docs/configuring-webhooks.md index ac98bcc8d2..c1686a3e79 100644 --- a/runatlantis.io/docs/configuring-webhooks.md +++ b/runatlantis.io/docs/configuring-webhooks.md @@ -11,7 +11,7 @@ See the instructions for your specific provider below. [[toc]] ## GitHub/GitHub Enterprise -You can install your webhook at the [organization](https://help.github.com/articles/differences-between-user-and-organization-accounts/) level, or for each individual repository. +You can install your webhook at the [organization](https://docs.github.com/en/get-started/learning-about-github/types-of-github-accounts) level, or for each individual repository. ::: tip NOTE If only some of the repos in your organization are to be managed by Atlantis, then you @@ -119,6 +119,6 @@ Repeat the process above until you have webhook subscriptions for the following ## Next Steps * To verify that Atlantis is receiving your webhooks, create a test pull request - to your repo. + to your repo. * You should see the request show up in the Atlantis logs at an `INFO` level. * You'll now need to configure Atlantis to add your [Provider Credentials](provider-credentials.md) diff --git a/runatlantis.io/docs/server-configuration.md b/runatlantis.io/docs/server-configuration.md index 139b4489e6..e4bfd60041 100644 --- a/runatlantis.io/docs/server-configuration.md +++ b/runatlantis.io/docs/server-configuration.md @@ -309,7 +309,7 @@ Values are chosen in this order: # or (recommended) ATLANTIS_GH_WEBHOOK_SECRET='secret' atlantis server ``` - Secret used to validate GitHub webhooks (see [https://developer.github.com/webhooks/securing/](https://docs.github.com/en/free-pro-team@latest/developers/webhooks-and-events/securing-your-webhooks)). + Secret used to validate GitHub webhooks (see [https://developer.github.com/webhooks/securing/](https://docs.github.com/en/developers/webhooks-and-events/webhooks/securing-your-webhooks)). ::: warning SECURITY WARNING If not specified, Atlantis won't be able to validate that the incoming webhook call came from GitHub. @@ -326,7 +326,7 @@ Values are chosen in this order: ```bash atlantis server --gh-app-id="00000" ``` - GitHub app ID. If set, GitHub authentication will be performed as [an installation](https://developer.github.com/v3/apps/installations/). + GitHub app ID. If set, GitHub authentication will be performed as [an installation](https://docs.github.com/en/rest/reference/apps#installations). ::: tip A GitHub app can be created by starting Atlantis first, then pointing your browser at @@ -348,18 +348,18 @@ Values are chosen in this order: ```bash atlantis server --gh-app-key-file="path/to/app-key.pem" ``` - Path to a GitHub App PEM encoded private key file. If set, GitHub authentication will be performed as [an installation](https://developer.github.com/v3/apps/installations/). + Path to a GitHub App PEM encoded private key file. If set, GitHub authentication will be performed as [an installation](https://docs.github.com/en/rest/reference/apps#installations). - ### `--gh-app-key` ```bash - atlantis server --gh-app-key="-----BEGIN RSA PRIVATE KEY-----(...)" + atlantis server --gh-app-key="-----BEGIN RSA PRIVATE KEY-----(...)" ``` The PEM encoded private key for the GitHub App. ::: warning SECURITY WARNING The contents of the private key will be visible by anyone that can run `ps` or look at the shell history of the machine where Atlantis is running. Use `--gh-app-key-file` to mitigate that risk. ::: -- +- - ### `--gh-team-allowlist` ```bash atlantis server --gh-team-allowlist="myteam:plan, secteam:apply"