From e711df9afa7265fbb2c91f1d76652f5ecd0e5cf6 Mon Sep 17 00:00:00 2001 From: Aolin Date: Thu, 22 Feb 2024 12:06:36 +0800 Subject: [PATCH 1/2] fix typos in deployment.mdx --- website/docs/deployment.mdx | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/website/docs/deployment.mdx b/website/docs/deployment.mdx index a5c9231bcdbd..ad5a06e9ed39 100644 --- a/website/docs/deployment.mdx +++ b/website/docs/deployment.mdx @@ -103,7 +103,7 @@ If you are unsure of which one to choose, ask the following questions: - 🔴 Self-hosting requires experience in networking as well as Linux and web server administration. It's the most difficult option, and would require the most time to manage successfully. Expense-wise, cloud services are almost never free, and purchasing/deploying an onsite server can be even more costly. -- 🟢 Jamstack providers can help you set up a working website in almost no time and offers features like server-side redirects that are easily configurable. Many providers offer generous build-time quotas even for free plans that you would almost never exceed. However, free plans have limits, and you would need to pay once you hit those limits. Check the pricing page of your provider for details. +- 🟢 Jamstack providers can help you set up a working website in almost no time and offer features like server-side redirects that are easily configurable. Many providers offer generous build-time quotas even for free plans that you would almost never exceed. However, free plans have limits, and you would need to pay once you hit those limits. Check the pricing page of your provider for details. - 🟡 The GitHub Pages deployment workflow can be tedious to set up. (Evidence: see the length of [Deploying to GitHub Pages](#deploying-to-github-pages)!) However, this service (including build and deployment) is always free for public repositories, and we have detailed instructions to help you make it work. @@ -473,12 +473,12 @@ 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 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`. At this point, you should have: - the source repo with the GitHub workflow set with the private SSH key as the GitHub Secret, and -- your deployment repo set with the public SSH key in GitHub Deploy Keys. +- your deployment repo is set with the public SSH key in GitHub Deploy Keys.
@@ -772,7 +772,7 @@ That's it. Watch the status and wait till the app is deployed. To open the appli Surge is a [static web hosting platform](https://surge.sh/help/getting-started-with-surge) that you can use to deploy your Docusaurus project from the command line in seconds. Deploying your project to Surge is easy and free (including custom domains and SSL certs). -Deploy your app in a matter of seconds using surge with the following steps: +Deploy your app in a matter of seconds using Surge with the following steps: 1. First, install Surge using npm by running the following command: ```bash npm2yarn From 8ebf13ae7a233647263e13285db3cc960ebd8f8a Mon Sep 17 00:00:00 2001 From: Aolin Date: Thu, 22 Feb 2024 13:18:08 +0800 Subject: [PATCH 2/2] Apply suggestions from code review --- website/docs/deployment.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/deployment.mdx b/website/docs/deployment.mdx index ad5a06e9ed39..74c566bb2f8d 100644 --- a/website/docs/deployment.mdx +++ b/website/docs/deployment.mdx @@ -478,7 +478,7 @@ A cross-repo publish is more difficult to set up because you need to push to ano At this point, you should have: - the source repo with the GitHub workflow set with the private SSH key as the GitHub Secret, and -- your deployment repo is set with the public SSH key in GitHub Deploy Keys. +- your deployment repo set with the public SSH key in GitHub Deploy Keys.