Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/content/docs/codebase-best-practices.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ We are striving to support right-to-left (RTL) layout in the codebase for langua

## General JavaScript

In most cases, our [linter](how-to-setup-freecodecamp-locally#follow-these-steps-to-get-your-development-environment-ready) will warn of any formatting which goes against this codebase's preferred practice.
In most cases, our [linter](/how-to-setup-freecodecamp-locally#follow-these-steps-to-get-your-development-environment-ready) will warn of any formatting which goes against this codebase's preferred practice.

It is encouraged to use functional components over class-based components.

Expand Down
4 changes: 2 additions & 2 deletions src/content/docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Yes - You can contribute to any of the 30+ languages we have enabled on our tran

We have user-contributed translations live in some languages. We intend to localize freeCodeCamp into several major world languages. You can read all about this in our [announcement here](https://www.freecodecamp.org/news/help-translate-freecodecamp-language/).

If you are interested in contributing to translations please make sure you [read this guide](how-to-translate-files) first.
If you are interested in contributing to translations please make sure you [read this guide](/how-to-translate-files) first.

## Can I contribute articles to freeCodeCamp News or videos to freeCodeCamp's YouTube channel?

Expand Down Expand Up @@ -93,7 +93,7 @@ Altogether, be respectful to others. We are humans from all around the world. Wi

If you practice the above **consistently for a while** and our fellow moderator members recommend you, a staff member will reach out and onboard you to the moderators' team. Open source work is voluntary work and our time is limited. We acknowledge that this is probably true in your case as well. So we emphasize being **consistent** rather than engaging in the community 24/7.

Take a look at our [Moderator Handbook](moderator-handbook) for a more exhaustive list of other responsibilities and expectations we have of our moderators.
Take a look at our [Moderator Handbook](/moderator-handbook) for a more exhaustive list of other responsibilities and expectations we have of our moderators.

## I am stuck on something that is not included in this documentation.

Expand Down
8 changes: 4 additions & 4 deletions src/content/docs/how-to-add-cypress-tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,14 @@ 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#cypress-gitpod-setup)
If using Gitpod, please see [Cypress-Gitpod Setup](/how-to-add-cypress-tests#cypress-gitpod-setup)
:::

### 1. Ensure that MongoDB and Client Applications are Running

- [Start MongoDB and seed the database](how-to-setup-freecodecamp-locally#step-3-start-mongodb-and-seed-the-database)
- [Start MongoDB and seed the database](/how-to-setup-freecodecamp-locally#step-3-start-mongodb-and-seed-the-database)

- [Start the freeCodeCamp client application and API server](how-to-setup-freecodecamp-locally#step-4-start-the-freecodecamp-client-application-and-api-server)
- [Start the freeCodeCamp client application and API server](/how-to-setup-freecodecamp-locally#step-4-start-the-freecodecamp-client-application-and-api-server)

### 2. Run the Cypress Tests

Expand Down Expand Up @@ -85,7 +85,7 @@ pnpm run cypress:install-build-tools

- When prompted in the terminal, select your keyboard layout by language/area

Now, [Cypress can be run](how-to-add-cypress-tests#_2-run-the-cypress-tests)
Now, [Cypress can be run](/how-to-add-cypress-tests#_2-run-the-cypress-tests)

## Troubleshooting

Expand Down
4 changes: 2 additions & 2 deletions src/content/docs/how-to-add-playwright-tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -157,9 +157,9 @@ describe('The campers landing page', () => {

### Ensure that MongoDB and Client Applications are Running

- [Start MongoDB and seed the database](how-to-setup-freecodecamp-locally#step-3-start-mongodb-and-seed-the-database). In order for Playwright tests to work, be sure that you use the `pnpm run seed:certified-user` command.
- [Start MongoDB and seed the database](/how-to-setup-freecodecamp-locally#step-3-start-mongodb-and-seed-the-database). In order for Playwright tests to work, be sure that you use the `pnpm run seed:certified-user` command.

- [Start the freeCodeCamp client application and API server](how-to-setup-freecodecamp-locally#step-4-start-the-freecodecamp-client-application-and-api-server)
- [Start the freeCodeCamp client application and API server](/how-to-setup-freecodecamp-locally#step-4-start-the-freecodecamp-client-application-and-api-server)

### Run the Playwright Tests

Expand Down
4 changes: 2 additions & 2 deletions src/content/docs/how-to-contribute-to-the-codebase.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Ignoring these steps may soil your copy which makes the contributing, maintainin

## Contributing to the Codebase

You can now make changes to files and commit your changes to your fork, which you can prepare by reading [how to set up freeCodeCamp locally](how-to-setup-freecodecamp-locally).
You can now make changes to files and commit your changes to your fork, which you can prepare by reading [how to set up freeCodeCamp locally](/how-to-setup-freecodecamp-locally).

Follow these steps:

Expand Down Expand Up @@ -201,7 +201,7 @@ The resulting output should be empty. This process is important, because you wil

## Proposing a Pull Request (PR)

After you've committed your changes, check here for [how to open a Pull Request](how-to-open-a-pull-request).
After you've committed your changes, check here for [how to open a Pull Request](/how-to-open-a-pull-request).

## Quick commands reference

Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/how-to-enable-new-languages.md
Original file line number Diff line number Diff line change
Expand Up @@ -237,7 +237,7 @@ You don't have to have everything in these 3 files translated at first. It's pos

You can replace any URLs that you have corresponding pages ready in your language.

For example, if you have a publication in your language, you can replace the URL for `"news"`. If you want to translate articles listed in the footer links, see [How to Translate Articles in the Footer Links](language-lead-handbook#how-to-translate-articles-in-the-footer-links).
For example, if you have a publication in your language, you can replace the URL for `"news"`. If you want to translate articles listed in the footer links, see [How to Translate Articles in the Footer Links](/language-lead-handbook#how-to-translate-articles-in-the-footer-links).

#### `meta-tags.json`

Expand Down
4 changes: 2 additions & 2 deletions src/content/docs/how-to-help-with-video-challenges.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ Skim the YouTube video with that `videoId` and think of a multiple-choice questi

### Add the Question to the Markdown File

You can add the question locally or using the GitHub interface. To add the question locally, you need to [set up freeCodeCamp locally](how-to-setup-freecodecamp-locally). You can also find the file on GitHub and click the edit button to add the question right in your browser.
You can add the question locally or using the GitHub interface. To add the question locally, you need to [set up freeCodeCamp locally](/how-to-setup-freecodecamp-locally). You can also find the file on GitHub and click the edit button to add the question right in your browser.

If a question has not yet been added to a particular video challenge, it will have the following default question:

Expand Down Expand Up @@ -205,4 +205,4 @@ For more examples, you can look at the markdown files for the following video co

## Open a Pull Request

After creating one or more questions, you can commit the changes to a new branch and [open a pull request](how-to-open-a-pull-request).
After creating one or more questions, you can commit the changes to a new branch and [open a pull request](/how-to-open-a-pull-request).
6 changes: 3 additions & 3 deletions src/content/docs/how-to-open-a-pull-request.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Some examples of this are:
6. Do not work directly off your `main` branch - create a new branch for the changes you are working on.

:::note
Your PR should be targeting changes to the English curriculum only. Read [this guide](intro#translations) instead for contributing to translations.
Your PR should be targeting changes to the English curriculum only. Read [this guide](/intro#translations) instead for contributing to translations.
:::

## Prepare a Good PR Title
Expand Down Expand Up @@ -97,7 +97,7 @@ Some examples of good PR titles would be:

- This is very important when making changes that are not just edits to text content like documentation or a challenge description. Examples of changes that need local testing include JavaScript, CSS, or HTML, which could change the functionality or layout of a page.

- If your PR affects the behavior of a page, it should be accompanied by corresponding [Playwright integration tests](how-to-add-playwright-tests).
- If your PR affects the behavior of a page, it should be accompanied by corresponding [Playwright integration tests](/how-to-add-playwright-tests).

## Feedback on Pull Requests

Expand All @@ -108,7 +108,7 @@ Our moderators will now take a look and leave you feedback. Please be patient wi
And as always, feel free to ask questions on the ['Contributors' category on our forum](https://forum.freecodecamp.org/c/contributors) or [the contributors chat room](https://discord.gg/PRyKn3Vbay).

:::tip
If you are to be contributing more pull requests, we recommend you read the [making changes and syncing](how-to-setup-freecodecamp-locally#making-changes-locally) guidelines to avoid having to delete your fork.
If you are to be contributing more pull requests, we recommend you read the [making changes and syncing](/how-to-setup-freecodecamp-locally#making-changes-locally) guidelines to avoid having to delete your fork.
:::

## Conflicts on a Pull Request
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/how-to-proofread-files.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ You should see the list of projects you have been granted access to. Select the
You should now see the list of available files. Choose your file by selecting the `Proofread` button on the right of that file, then choosing `Proofreading` from the drop-down menu that appears.

:::note
If you are in this workspace view, but want to work on [translating a file](how-to-translate-files) instead of proofreading, you may select `Crowdsourcing` from the dropdown menu instead.
If you are in this workspace view, but want to work on [translating a file](/how-to-translate-files) instead of proofreading, you may select `Crowdsourcing` from the dropdown menu instead.
:::

## Proofread Translations
Expand Down
12 changes: 6 additions & 6 deletions src/content/docs/how-to-setup-freecodecamp-locally.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ Follow these guidelines for setting up a development environment for freeCodeCam

:::danger

- freeCodeCamp does not build and run natively on Windows, you will [need to use WSL2](how-to-setup-wsl) for a Linux-like setup on Windows.
- freeCodeCamp does not build and run natively on Windows, you will [need to use WSL2](/how-to-setup-wsl) for a Linux-like setup on Windows.
- You can't use Windows Command Prompt, Git Bash or PowerShell to build and run the codebase.
- Note that if using Windows, the hardware requirements need to be more than [what we mention](how-to-setup-freecodecamp-locally?id=how-to-prepare-your-local-machine) to accommodate for WSL-based setup.
- Note that if using Windows, the hardware requirements need to be more than [what we mention](/how-to-setup-freecodecamp-locally?id=how-to-prepare-your-local-machine) to accommodate for WSL-based setup.

:::

Expand Down Expand Up @@ -70,7 +70,7 @@ Here is a minimum system requirement for running freeCodeCamp locally:

Start by installing the prerequisite software for your operating system.

We primarily support development on Linux and Unix-based systems like Ubuntu and macOS. You can develop on Windows 10 or 11 with WSL2 only. You can follow [this guide](how-to-setup-wsl) to set up WSL2. You can't use Command Prompt, Git Bash or PowerShell to run freeCodeCamp natively within windows.
We primarily support development on Linux and Unix-based systems like Ubuntu and macOS. You can develop on Windows 10 or 11 with WSL2 only. You can follow [this guide](/how-to-setup-wsl) to set up WSL2. You can't use Command Prompt, Git Bash or PowerShell to run freeCodeCamp natively within windows.

#### Prerequisites:

Expand All @@ -81,7 +81,7 @@ We primarily support development on Linux and Unix-based systems like Ubuntu and
| [MongoDB Community Server](https://docs.mongodb.com/manual/administration/install-community/) | `5.0.x` | - |

:::danger
If you have a different version, please install the recommended version. We can only support installation issues for recommended versions. See [troubleshooting section](troubleshooting-development-issues) for details.
If you have a different version, please install the recommended version. We can only support installation issues for recommended versions. See [troubleshooting section](/troubleshooting-development-issues) for details.
:::

If Node.js is already installed on your machine, run the following commands to validate the versions:
Expand Down Expand Up @@ -253,7 +253,7 @@ Before you can run the application locally, you will need to start the MongoDB s
:::note
Unless you have MongoDB running in a setup different than the default, the URL stored as the `MONGOHQ_URL` value in the `.env` file should work fine. If you are using a custom configuration, modify this value as needed.

If you followed along with the [Windows 10 via WSL2 Setup Guide](how-to-setup-wsl), then you should be able to skip this step if the MongoDB server from that guide is already running. You can confirm this by checking that you can reach `http://localhost:27017` on your local machine.
If you followed along with the [Windows 10 via WSL2 Setup Guide](/how-to-setup-wsl), then you should be able to skip this step if the MongoDB server from that guide is already running. You can confirm this by checking that you can reach `http://localhost:27017` on your local machine.
:::
Start the MongoDB server in a separate terminal:

Expand Down Expand Up @@ -301,7 +301,7 @@ While you are logged in, if you visit <http://localhost:3000/explorer> you shoul
Clearing your cookies or running `pnpm run seed:certified-user` will log you out, and you will have to sign in again.
:::

If you have issues while installing it, check out the [troubleshooting section](troubleshooting-development-issues).
If you have issues while installing it, check out the [troubleshooting section](/troubleshooting-development-issues).

## Quick Commands Reference

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -475,7 +475,7 @@ You only need to follow this section if you're modifying the challenge test runn

## Proposing a Pull Request (PR)

After you've committed your changes, check here for [how to open a Pull Request](how-to-open-a-pull-request).
After you've committed your changes, check here for [how to open a Pull Request](/how-to-open-a-pull-request).

<!-- ## Quick commands reference - NEED TO DISCUSS ABOUT THIS

Expand Down
6 changes: 3 additions & 3 deletions src/content/docs/how-to-setup-wsl.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Before you follow these instructions make sure your system meets the requirement
**Docker Desktop for Windows**: See respective requirements for [Windows 10 Pro](https://docs.docker.com/docker-for-windows/install/#system-requirements) and [Windows 10 Home](https://docs.docker.com/docker-for-windows/install-windows-home/#system-requirements)
:::

This guide covers some common steps with the setup of WSL2. Once some of the common issues with WSL2 are addressed, you should be able to follow [this local setup guide](how-to-setup-freecodecamp-locally) to work with freeCodeCamp on Windows running a WSL distro like Ubuntu.
This guide covers some common steps with the setup of WSL2. Once some of the common issues with WSL2 are addressed, you should be able to follow [this local setup guide](/how-to-setup-freecodecamp-locally) to work with freeCodeCamp on Windows running a WSL distro like Ubuntu.

## Enable WSL

Expand Down Expand Up @@ -78,7 +78,7 @@ Once you have configured Docker Desktop to work with WSL2, follow these steps to

1. Launch a new Ubuntu terminal

2. Pull MongoDB from Docker Hub. Please refer to the [Prerequisites](how-to-setup-freecodecamp-locally#Prerequisites) table for the current version of MongoDB used by freeCodeCamp. For example, if the version number is `5.0.x`, replace `<x.y>` with `5.0` in the following two code snippets.
2. Pull MongoDB from Docker Hub. Please refer to the [Prerequisites](/how-to-setup-freecodecamp-locally#Prerequisites) table for the current version of MongoDB used by freeCodeCamp. For example, if the version number is `5.0.x`, replace `<x.y>` with `5.0` in the following two code snippets.

```bash
docker pull mongo:<x.y>
Expand Down Expand Up @@ -117,7 +117,7 @@ npm install -g pnpm

## Set up freeCodeCamp Locally

Now that you have installed the pre-requisites, follow [our local setup guide](how-to-setup-freecodecamp-locally) to clone, install and set up freeCodeCamp locally on your machine.
Now that you have installed the pre-requisites, follow [our local setup guide](/how-to-setup-freecodecamp-locally) to clone, install and set up freeCodeCamp locally on your machine.

:::warning
Please note, at this time the setup for Cypress tests (and related GUI needs) is a work in progress. You should still be able to work on most of the codebase.
Expand Down
6 changes: 3 additions & 3 deletions src/content/docs/how-to-translate-files.md
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ Our `/learn` interface relies on JSON files loaded into an i18n plugin to genera

The `links.json`, `meta-tags.json`, `motivation.json`, and `trending.json` files contain information that needs to be updated to reflect your language. However, we cannot load these into Crowdin, as the content isn't something that would be a one-to-one translation.

These files will most likely be maintained by your language lead but you are welcome to [read about how to translate them](language-lead-handbook).
These files will most likely be maintained by your language lead but you are welcome to [read about how to translate them](/language-lead-handbook).

### On Crowdin

Expand Down Expand Up @@ -203,9 +203,9 @@ After translation

The actual files in docs are written in Markdown, but they will appear as HTML tags on Crowdin.

You can find out how `docsify` converts a string in your language into an id by looking into the translated pages. If the translation is not deployed yet, you can preview it by [running the docs site locally](how-to-work-on-the-docs-theme#serving-the-documentation-site-locally).
You can find out how `docsify` converts a string in your language into an id by looking into the translated pages. If the translation is not deployed yet, you can preview it by [running the docs site locally](/how-to-work-on-the-docs-theme#serving-the-documentation-site-locally).

You can learn more about [internal links in our docs here](how-to-work-on-the-docs-theme#how-to-create-an-internal-link).
You can learn more about [internal links in our docs here](/how-to-work-on-the-docs-theme#how-to-create-an-internal-link).

## Translate the LearnToCode RPG

Expand Down
Loading