docs(v2): update steps in the github-actions section #4876
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
✔️ [V2] 🔨 Explore the source changes: 60a23d1 🔍 Inspect the deploy log: https://app.netlify.com/sites/docusaurus-2/deploys/60b60ab5834a6200089f6074 😎 Browse the preview: https://deploy-preview-4876--docusaurus-2.netlify.app |
|
⚡️ Lighthouse report for the changes in this PR:
Lighthouse ran on https://deploy-preview-4876--docusaurus-2.netlify.app/ |
|
I just realised that I didn't update current and older version of the documentation 😅. Will do that.. |
HonkingGoose
suggested changes
Jun 1, 2021
| @@ -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 [email protected] with your github email and gh-actions with your name | |||
There was a problem hiding this comment.
Suggested change
| Please make sure that you replace [email protected] with your github email and gh-actions with your name | |
| Please make sure that you replace `[email protected]` with your GitHub email and `gh-actions` with your name. |
| @@ -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 [email protected] with your github email and gh-actions with your name | |||
There was a problem hiding this comment.
Suggested change
| Please make sure that you replace [email protected] with your github email and gh-actions with your name | |
| Please make sure that you replace `[email protected]` with your GitHub email and `gh-actions` with your name. |
HonkingGoose
suggested changes
Jun 1, 2021
Co-authored-by: HonkingGoose <[email protected]>
|
thanks |
slorber
changed the title
slorber
added
the
pr: documentation
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Created a warning, asking users to replace email and name in the GitHub action with their email and name.
Motivation
I ran into issues when setting up github actions.
Have you read the Contributing Guidelines on pull requests?
Yes
Test Plan
(Write your test plan here. If you changed any code, please provide us with clear instructions on how you verified your changes work. Bonus points for screenshots and videos!)
Related PRs
(If this PR adds or changes functionality, please take some time to update the docs at https://github.com/facebook/docusaurus, and link to your PR here.)