docs(v2): update steps in the github-actions section (#4876)

* docs: update steps in the github-actions section

* refactor: format warning

* Update website/docs/deployment.mdx

Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>

Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
This commit is contained in:
Fardeen Panjwani 2021-06-01 21:35:26 +05:30 committed by GitHub
parent 60e2de6c04
commit 62caaeddbb
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 30 additions and 0 deletions

View file

@ -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

View file

@ -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

View file

@ -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

View file

@ -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

View file

@ -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