From 009af9d5e6303cfccb4988b403ecc41653c2d06a Mon Sep 17 00:00:00 2001 From: Chris Cho <52428683+ccho-mongodb@users.noreply.github.com> Date: Thu, 12 Sep 2024 14:37:30 -0400 Subject: [PATCH] Docs: Fix link to GitHub workflow file docs --- website/docs/deployment.mdx | 2 +- website/versioned_docs/version-2.x/deployment.mdx | 2 +- website/versioned_docs/version-3.0.1/deployment.mdx | 2 +- website/versioned_docs/version-3.1.1/deployment.mdx | 2 +- website/versioned_docs/version-3.2.1/deployment.mdx | 2 +- website/versioned_docs/version-3.3.2/deployment.mdx | 2 +- website/versioned_docs/version-3.4.0/deployment.mdx | 2 +- website/versioned_docs/version-3.5.2/deployment.mdx | 2 +- 8 files changed, 8 insertions(+), 8 deletions(-) diff --git a/website/docs/deployment.mdx b/website/docs/deployment.mdx index d52616e0ceeb..d80af32c4b87 100644 --- a/website/docs/deployment.mdx +++ b/website/docs/deployment.mdx @@ -477,7 +477,7 @@ A cross-repo publish is more difficult to set up because you need to push to ano 3. Copy the key to clipboard with `pbcopy < ~/.ssh/id_rsa.pub` and paste it as a [deploy key](https://developer.github.com/v3/guides/managing-deploy-keys/#deploy-keys) in the deployment repository. Copy the file content if the command line doesn't work for you. Check the box for `Allow write access` before saving your deployment key. 4. You'll need your private key as a [GitHub secret](https://help.github.com/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets) to allow Docusaurus to run the deployment for you. 5. Copy your private key with `pbcopy < ~/.ssh/id_rsa` and paste a GitHub secret with the name `GH_PAGES_DEPLOY` on your source repository. Copy the file content if the command line doesn't work for you. Save your secret. -6. Create your [documentation workflow file](https://help.github.com/en/actions/configuring-and-managing-workflows/configuring-a-workflow#creating-a-workflow-file) in `.github/workflows/`. In this example, it's `deploy.yml`. +6. Create your [documentation workflow](https://docs.github.com/en/actions/use-cases-and-examples/creating-an-example-workflow) in the `.github/workflows/` directory. In this example it's the `deploy.yml` file. At this point, you should have: diff --git a/website/versioned_docs/version-2.x/deployment.mdx b/website/versioned_docs/version-2.x/deployment.mdx index c45e7fc6c10d..4269c865d203 100644 --- a/website/versioned_docs/version-2.x/deployment.mdx +++ b/website/versioned_docs/version-2.x/deployment.mdx @@ -467,7 +467,7 @@ A cross-repo publish is more difficult to set up, because you need to push to an 3. Copy the key to clipboard with `pbcopy < ~/.ssh/id_rsa.pub` and paste it as a [deploy key](https://developer.github.com/v3/guides/managing-deploy-keys/#deploy-keys) in the deployment repository. Copy the file content if the command line doesn't work for you. Check the box for `Allow write access` before saving your deployment key. 4. You'll need your private key as a [GitHub secret](https://help.github.com/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets) to allow Docusaurus to run the deployment for you. 5. Copy your private key with `pbcopy < ~/.ssh/id_rsa` and paste a GitHub secret with the name `GH_PAGES_DEPLOY` on your source repository. Copy the file content if the command line doesn't work for you. Save your secret. -6. Create your [documentation workflow file](https://help.github.com/en/actions/configuring-and-managing-workflows/configuring-a-workflow#creating-a-workflow-file) in `.github/workflows/`. In this example it's `deploy.yml`. +6. Create your [documentation workflow](https://docs.github.com/en/actions/use-cases-and-examples/creating-an-example-workflow) in the `.github/workflows/` directory. In this example it's the `deploy.yml` file. 7. You should have essentially: the source repo with the GitHub workflow set with the private SSH key as GitHub Secret and your deployment repo set with the public SSH key in GitHub Deploy Keys.
diff --git a/website/versioned_docs/version-3.0.1/deployment.mdx b/website/versioned_docs/version-3.0.1/deployment.mdx index e5a0df6f57f6..08d03d680525 100644 --- a/website/versioned_docs/version-3.0.1/deployment.mdx +++ b/website/versioned_docs/version-3.0.1/deployment.mdx @@ -469,7 +469,7 @@ A cross-repo publish is more difficult to set up because you need to push to ano 3. Copy the key to clipboard with `pbcopy < ~/.ssh/id_rsa.pub` and paste it as a [deploy key](https://developer.github.com/v3/guides/managing-deploy-keys/#deploy-keys) in the deployment repository. Copy the file content if the command line doesn't work for you. Check the box for `Allow write access` before saving your deployment key. 4. You'll need your private key as a [GitHub secret](https://help.github.com/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets) to allow Docusaurus to run the deployment for you. 5. Copy your private key with `pbcopy < ~/.ssh/id_rsa` and paste a GitHub secret with the name `GH_PAGES_DEPLOY` on your source repository. Copy the file content if the command line doesn't work for you. Save your secret. -6. Create your [documentation workflow file](https://help.github.com/en/actions/configuring-and-managing-workflows/configuring-a-workflow#creating-a-workflow-file) in `.github/workflows/`. In this example it's `deploy.yml`. +6. Create your [documentation workflow](https://docs.github.com/en/actions/use-cases-and-examples/creating-an-example-workflow) in the `.github/workflows/` directory. In this example it's the `deploy.yml` file. At this point, you should have: diff --git a/website/versioned_docs/version-3.1.1/deployment.mdx b/website/versioned_docs/version-3.1.1/deployment.mdx index a5c9231bcdbd..7dc8335ede3b 100644 --- a/website/versioned_docs/version-3.1.1/deployment.mdx +++ b/website/versioned_docs/version-3.1.1/deployment.mdx @@ -473,7 +473,7 @@ A cross-repo publish is more difficult to set up because you need to push to ano 3. Copy the key to clipboard with `pbcopy < ~/.ssh/id_rsa.pub` and paste it as a [deploy key](https://developer.github.com/v3/guides/managing-deploy-keys/#deploy-keys) in the deployment repository. Copy the file content if the command line doesn't work for you. Check the box for `Allow write access` before saving your deployment key. 4. You'll need your private key as a [GitHub secret](https://help.github.com/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets) to allow Docusaurus to run the deployment for you. 5. Copy your private key with `pbcopy < ~/.ssh/id_rsa` and paste a GitHub secret with the name `GH_PAGES_DEPLOY` on your source repository. Copy the file content if the command line doesn't work for you. Save your secret. -6. Create your [documentation workflow file](https://help.github.com/en/actions/configuring-and-managing-workflows/configuring-a-workflow#creating-a-workflow-file) in `.github/workflows/`. In this example it's `deploy.yml`. +6. Create your [documentation workflow](https://docs.github.com/en/actions/use-cases-and-examples/creating-an-example-workflow) in the `.github/workflows/` directory. In this example it's the `deploy.yml` file. At this point, you should have: diff --git a/website/versioned_docs/version-3.2.1/deployment.mdx b/website/versioned_docs/version-3.2.1/deployment.mdx index 9048c4a4d1ae..1a8f59941902 100644 --- a/website/versioned_docs/version-3.2.1/deployment.mdx +++ b/website/versioned_docs/version-3.2.1/deployment.mdx @@ -477,7 +477,7 @@ A cross-repo publish is more difficult to set up because you need to push to ano 3. Copy the key to clipboard with `pbcopy < ~/.ssh/id_rsa.pub` and paste it as a [deploy key](https://developer.github.com/v3/guides/managing-deploy-keys/#deploy-keys) in the deployment repository. Copy the file content if the command line doesn't work for you. Check the box for `Allow write access` before saving your deployment key. 4. You'll need your private key as a [GitHub secret](https://help.github.com/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets) to allow Docusaurus to run the deployment for you. 5. Copy your private key with `pbcopy < ~/.ssh/id_rsa` and paste a GitHub secret with the name `GH_PAGES_DEPLOY` on your source repository. Copy the file content if the command line doesn't work for you. Save your secret. -6. Create your [documentation workflow file](https://help.github.com/en/actions/configuring-and-managing-workflows/configuring-a-workflow#creating-a-workflow-file) in `.github/workflows/`. In this example, it's `deploy.yml`. +6. Create your [documentation workflow](https://docs.github.com/en/actions/use-cases-and-examples/creating-an-example-workflow) in the `.github/workflows/` directory. In this example it's the `deploy.yml` file. At this point, you should have: diff --git a/website/versioned_docs/version-3.3.2/deployment.mdx b/website/versioned_docs/version-3.3.2/deployment.mdx index d52616e0ceeb..d80af32c4b87 100644 --- a/website/versioned_docs/version-3.3.2/deployment.mdx +++ b/website/versioned_docs/version-3.3.2/deployment.mdx @@ -477,7 +477,7 @@ A cross-repo publish is more difficult to set up because you need to push to ano 3. Copy the key to clipboard with `pbcopy < ~/.ssh/id_rsa.pub` and paste it as a [deploy key](https://developer.github.com/v3/guides/managing-deploy-keys/#deploy-keys) in the deployment repository. Copy the file content if the command line doesn't work for you. Check the box for `Allow write access` before saving your deployment key. 4. You'll need your private key as a [GitHub secret](https://help.github.com/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets) to allow Docusaurus to run the deployment for you. 5. Copy your private key with `pbcopy < ~/.ssh/id_rsa` and paste a GitHub secret with the name `GH_PAGES_DEPLOY` on your source repository. Copy the file content if the command line doesn't work for you. Save your secret. -6. Create your [documentation workflow file](https://help.github.com/en/actions/configuring-and-managing-workflows/configuring-a-workflow#creating-a-workflow-file) in `.github/workflows/`. In this example, it's `deploy.yml`. +6. Create your [documentation workflow](https://docs.github.com/en/actions/use-cases-and-examples/creating-an-example-workflow) in the `.github/workflows/` directory. In this example it's the `deploy.yml` file. At this point, you should have: diff --git a/website/versioned_docs/version-3.4.0/deployment.mdx b/website/versioned_docs/version-3.4.0/deployment.mdx index d52616e0ceeb..d80af32c4b87 100644 --- a/website/versioned_docs/version-3.4.0/deployment.mdx +++ b/website/versioned_docs/version-3.4.0/deployment.mdx @@ -477,7 +477,7 @@ A cross-repo publish is more difficult to set up because you need to push to ano 3. Copy the key to clipboard with `pbcopy < ~/.ssh/id_rsa.pub` and paste it as a [deploy key](https://developer.github.com/v3/guides/managing-deploy-keys/#deploy-keys) in the deployment repository. Copy the file content if the command line doesn't work for you. Check the box for `Allow write access` before saving your deployment key. 4. You'll need your private key as a [GitHub secret](https://help.github.com/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets) to allow Docusaurus to run the deployment for you. 5. Copy your private key with `pbcopy < ~/.ssh/id_rsa` and paste a GitHub secret with the name `GH_PAGES_DEPLOY` on your source repository. Copy the file content if the command line doesn't work for you. Save your secret. -6. Create your [documentation workflow file](https://help.github.com/en/actions/configuring-and-managing-workflows/configuring-a-workflow#creating-a-workflow-file) in `.github/workflows/`. In this example, it's `deploy.yml`. +6. Create your [documentation workflow](https://docs.github.com/en/actions/use-cases-and-examples/creating-an-example-workflow) in the `.github/workflows/` directory. In this example it's the `deploy.yml` file. At this point, you should have: diff --git a/website/versioned_docs/version-3.5.2/deployment.mdx b/website/versioned_docs/version-3.5.2/deployment.mdx index d52616e0ceeb..d80af32c4b87 100644 --- a/website/versioned_docs/version-3.5.2/deployment.mdx +++ b/website/versioned_docs/version-3.5.2/deployment.mdx @@ -477,7 +477,7 @@ A cross-repo publish is more difficult to set up because you need to push to ano 3. Copy the key to clipboard with `pbcopy < ~/.ssh/id_rsa.pub` and paste it as a [deploy key](https://developer.github.com/v3/guides/managing-deploy-keys/#deploy-keys) in the deployment repository. Copy the file content if the command line doesn't work for you. Check the box for `Allow write access` before saving your deployment key. 4. You'll need your private key as a [GitHub secret](https://help.github.com/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets) to allow Docusaurus to run the deployment for you. 5. Copy your private key with `pbcopy < ~/.ssh/id_rsa` and paste a GitHub secret with the name `GH_PAGES_DEPLOY` on your source repository. Copy the file content if the command line doesn't work for you. Save your secret. -6. Create your [documentation workflow file](https://help.github.com/en/actions/configuring-and-managing-workflows/configuring-a-workflow#creating-a-workflow-file) in `.github/workflows/`. In this example, it's `deploy.yml`. +6. Create your [documentation workflow](https://docs.github.com/en/actions/use-cases-and-examples/creating-an-example-workflow) in the `.github/workflows/` directory. In this example it's the `deploy.yml` file. At this point, you should have: