From 170e13d285705d2f9ac470b145893dc3023138ef Mon Sep 17 00:00:00 2001 From: Fardeen Panjwani Date: Mon, 31 May 2021 21:54:15 +0530 Subject: [PATCH] docs: update steps in the github-actions section --- website/docs/deployment.mdx | 6 ++++++ .../versioned_docs/version-2.0.0-alpha.73/deployment.mdx | 6 ++++++ .../versioned_docs/version-2.0.0-alpha.74/deployment.mdx | 6 ++++++ .../versioned_docs/version-2.0.0-alpha.75/deployment.mdx | 6 ++++++ website/versioned_docs/version-2.0.0-beta.0/deployment.mdx | 6 ++++++ 5 files changed, 30 insertions(+) diff --git a/website/docs/deployment.mdx b/website/docs/deployment.mdx index c4187cdc1689..45832d407581 100644 --- a/website/docs/deployment.mdx +++ b/website/docs/deployment.mdx @@ -150,6 +150,12 @@ This workflow assumes your documentation resided in `documentation` branch of yo 1. Copy your private key with `xclip -sel clip < ~/.ssh/id_rsa` and paste a GitHub secret with name `GH_PAGES_DEPLOY`. Copy file content if the command line doesn't work for you. Save your secret. 1. Create you [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 `documentation.yml`. +:::warning + +Please make sure that you replace `actions@github.com` with your github email and `gh-actions` with your name + +::: + ```yaml title="documentation.yml" name: documentation diff --git a/website/versioned_docs/version-2.0.0-alpha.73/deployment.mdx b/website/versioned_docs/version-2.0.0-alpha.73/deployment.mdx index 175a7bab801c..6be966e86829 100644 --- a/website/versioned_docs/version-2.0.0-alpha.73/deployment.mdx +++ b/website/versioned_docs/version-2.0.0-alpha.73/deployment.mdx @@ -150,6 +150,12 @@ This workflow assumes your documentation resided in `documentation` branch of yo 1. Copy your private key with `xclip -sel clip < ~/.ssh/id_rsa` and paste a GitHub secret with name `GH_PAGES_DEPLOY`. Copy file content if the command line doesn't work for you. Save your secret. 1. Create you [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 `documentation.yml`. +:::warning + +Please make sure that you replace actions@github.com with your github email and gh-actions with your name + +::: + ```yaml title="documentation.yml" name: documentation diff --git a/website/versioned_docs/version-2.0.0-alpha.74/deployment.mdx b/website/versioned_docs/version-2.0.0-alpha.74/deployment.mdx index c4187cdc1689..1c9138731966 100644 --- a/website/versioned_docs/version-2.0.0-alpha.74/deployment.mdx +++ b/website/versioned_docs/version-2.0.0-alpha.74/deployment.mdx @@ -150,6 +150,12 @@ This workflow assumes your documentation resided in `documentation` branch of yo 1. Copy your private key with `xclip -sel clip < ~/.ssh/id_rsa` and paste a GitHub secret with name `GH_PAGES_DEPLOY`. Copy file content if the command line doesn't work for you. Save your secret. 1. Create you [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 `documentation.yml`. +:::warning + +Please make sure that you replace actions@github.com with your github email and gh-actions with your name + +::: + ```yaml title="documentation.yml" name: documentation diff --git a/website/versioned_docs/version-2.0.0-alpha.75/deployment.mdx b/website/versioned_docs/version-2.0.0-alpha.75/deployment.mdx index c4187cdc1689..1c9138731966 100644 --- a/website/versioned_docs/version-2.0.0-alpha.75/deployment.mdx +++ b/website/versioned_docs/version-2.0.0-alpha.75/deployment.mdx @@ -150,6 +150,12 @@ This workflow assumes your documentation resided in `documentation` branch of yo 1. Copy your private key with `xclip -sel clip < ~/.ssh/id_rsa` and paste a GitHub secret with name `GH_PAGES_DEPLOY`. Copy file content if the command line doesn't work for you. Save your secret. 1. Create you [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 `documentation.yml`. +:::warning + +Please make sure that you replace actions@github.com with your github email and gh-actions with your name + +::: + ```yaml title="documentation.yml" name: documentation diff --git a/website/versioned_docs/version-2.0.0-beta.0/deployment.mdx b/website/versioned_docs/version-2.0.0-beta.0/deployment.mdx index c4187cdc1689..1c9138731966 100644 --- a/website/versioned_docs/version-2.0.0-beta.0/deployment.mdx +++ b/website/versioned_docs/version-2.0.0-beta.0/deployment.mdx @@ -150,6 +150,12 @@ This workflow assumes your documentation resided in `documentation` branch of yo 1. Copy your private key with `xclip -sel clip < ~/.ssh/id_rsa` and paste a GitHub secret with name `GH_PAGES_DEPLOY`. Copy file content if the command line doesn't work for you. Save your secret. 1. Create you [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 `documentation.yml`. +:::warning + +Please make sure that you replace actions@github.com with your github email and gh-actions with your name + +::: + ```yaml title="documentation.yml" name: documentation