docs(v2): add deployment workflow manual for GitHub Actions #2670
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
Steps to build and deploy Docusaurus with GitHub Actions
|
Deploy preview for docusaurus-2 ready! Built with commit 2abceb7 |
lex111
changed the title
lex111
approved these changes
Apr 27, 2020
|
Thanks for updating style @lex111 |
Update my fork
yangshun
approved these changes
May 18, 2020
yangshun
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.
I built a workflow to deploy docs for our project with GitHub Actions. After testing it on our repository I'm happy to share it with other Docusaurus users.
Motivation
I haven't found nice docs on deploying Docusaurus with GitHub Actions. I spent quite some time to test out such a deployment for our project. I think it's a popular deployment option and other Docusaurus users will benefit from it.
Amended this towards
deployment.mdinmasteras requested.Have you read the Contributing Guidelines on pull requests?
Yes, I did.
Test Plan
These PR contributes only to documentations. I verified everything step by step in my project's repository which lead to successful deployment of documentation to GH Pages.
Here's green pipeline screenshot:
Here's a result hosted on GH pages:
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.)