From bacbbaecadbb15c07324e4a9e0bf232d6e6ea375 Mon Sep 17 00:00:00 2001 From: Shaun Hamilton Date: Fri, 12 May 2023 13:41:28 +0100 Subject: [PATCH] fix(docs): Gitpod not GitPod (#50364) --- docs/how-to-add-cypress-tests.md | 6 +++--- docs/how-to-setup-freecodecamp-locally.md | 14 +++++++------- docs/troubleshooting-development-issues.md | 2 +- 3 files changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/how-to-add-cypress-tests.md b/docs/how-to-add-cypress-tests.md index ca8234c090b..360f2843047 100644 --- a/docs/how-to-add-cypress-tests.md +++ b/docs/how-to-add-cypress-tests.md @@ -13,7 +13,7 @@ To learn how to write Cypress tests, or 'specs', please see Cypress' official [d ## How to Run Tests > [!NOTE] -> If using GitPod, please see [Cypress-GitPod Setup](how-to-add-cypress-tests.md#cypress-gitpod-setup) +> If using Gitpod, please see [Cypress-Gitpod Setup](how-to-add-cypress-tests.md#cypress-gitpod-setup) ### 1. Ensure that MongoDB and Client Applications are Running @@ -49,11 +49,11 @@ To run tests against production builds, replace `dev` with `prd` below. pnpm run e2e:dev:run ``` -## Cypress-GitPod Setup +## Cypress-Gitpod Setup ### 1. Ensure Development Environment is Running -If starting the GitPod environment did not automatically develop the environment: +If starting the Gitpod environment did not automatically develop the environment: - Follow the [MongoDB installation guide](https://www.mongodb.com/basics/get-started). - Create a config file. diff --git a/docs/how-to-setup-freecodecamp-locally.md b/docs/how-to-setup-freecodecamp-locally.md index d7e07819608..c7264f81b16 100644 --- a/docs/how-to-setup-freecodecamp-locally.md +++ b/docs/how-to-setup-freecodecamp-locally.md @@ -20,9 +20,9 @@ Here are some pros and cons which should help you decide which option is best fo ### How to Prepare a Gitpod Workspace -We have automated the process of installing all the dependencies & tools you will need. With GitPod you get a free ready-to-code environment in a few minutes, and is useful if you do not have access to computer or want to make one-time changes. +We have automated the process of installing all the dependencies & tools you will need. With Gitpod you get a free ready-to-code environment in a few minutes, and is useful if you do not have access to computer or want to make one-time changes. -There are various ways to launch an GitPod workspace: +There are various ways to launch an Gitpod workspace: 1. **(Fastest)** Prepend `gitpod.io/#` in front of any URL from GitHub. @@ -35,15 +35,15 @@ There are various ways to launch an GitPod workspace: - [Chrome Webstore](https://chrome.google.com/webstore/detail/gitpod-always-ready-to-co/dodmmooeoklaejobgleioelladacbeki) - works with Chromium-based browsers like Google Chrome, Brave, Edge, etc. - [Firefox Add-on](https://addons.mozilla.org/en-US/firefox/addon/gitpod) - Firefox - Once installed you will see a 'GitPod' button on every repository, pull-request, etc. as a handy shortcut to launch a workspace from there. See the extension page for details, screenshots, etc. + Once installed you will see a 'Gitpod' button on every repository, pull-request, etc. as a handy shortcut to launch a workspace from there. See the extension page for details, screenshots, etc. -That's it, you can now skip to the 'syncing up from parent' section after you have launched a GitPod workspace. Most parts of this guide applies to GitPod workspaces, but be mindful of [how the URLs & Ports work within a GitPod](https://www.gitpod.io/docs/configure/workspaces/ports) workspace. +That's it, you can now skip to the 'syncing up from parent' section after you have launched a Gitpod workspace. Most parts of this guide applies to Gitpod workspaces, but be mindful of [how the URLs & Ports work within a Gitpod](https://www.gitpod.io/docs/configure/workspaces/ports) workspace. -**Note: Troubleshooting port issues on GitPod** +**Note: Troubleshooting port issues on Gitpod** -Sometimes the service on `port:8000` doesn't go live. This is common when you are restarting an inactive workspace. +Sometimes the service on port `8000` doesn't go live. This is common when you are restarting an inactive workspace. -If the service is not coming up on `port:8000`, you can troubleshoot using these steps: +If the service is not coming up on port `8000`, you can troubleshoot using these steps: - **Start the server**: Run `pnpm run develop:server` in one terminal window from the root project directory (`/workspace/freeCodeCamp`) to start the server. diff --git a/docs/troubleshooting-development-issues.md b/docs/troubleshooting-development-issues.md index bca4428305a..b161258f1ec 100644 --- a/docs/troubleshooting-development-issues.md +++ b/docs/troubleshooting-development-issues.md @@ -89,7 +89,7 @@ There is a "Preview Custom 404 Page" button, click it to see the profile. If you get errors while installing the dependencies, please make sure that you are not in a restricted network or your firewall settings do not prevent you from accessing resources. -The first time setup can take a while depending on your network bandwidth. Be patient, and if you are still stuck we recommend using GitPod instead of an offline setup. +The first time setup can take a while depending on your network bandwidth. Be patient, and if you are still stuck we recommend using Gitpod instead of an offline setup. > [!NOTE] > If you are using Apple Devices with M1 Chip to run the application locally, it is suggested to use Node v14.7 or above. You might run into issues with dependencies like Sharp otherwise.