| 
1 | 1 | # [LambdaTest Documentation](https://lambdatest.com/support/docs/)  | 
2 |  | - | 
3 | 2 | Welcome to LambdaTest's documentation repository! Help us enhance our documentation by contributing—whether it's fixing a typo or adding new topics. We appreciate all contributions.  | 
4 | 3 | 
 
  | 
5 |  | ----  | 
6 |  | - | 
7 |  | - | 
8 | 4 | ## Contributing Content  | 
9 |  | - | 
10 | 5 | We recommend forking the repo, creating all content changes in branches, and submitting pull requests. We will work with you to get this content reviewed, tested, and merged for publishing.  | 
11 | 6 | 
 
  | 
12 | 7 | ## Building Locally  | 
13 |  | - | 
14 | 8 | Docusaurus requires the following to build on locals:  | 
15 | 9 | 
 
  | 
16 |  | -* [NodeJS](https://nodejs.org/en/download/) version recommended: 16.14.0)  | 
17 |  | -* Verify the Node.js version by opening Command Prompt/Terminal and running node -v  | 
18 |  | -* Download Git [here](https://git-scm.com/downloads)  | 
19 |  | -* [VS Code Editor](https://code.visualstudio.com/download)  | 
 | 10 | +- [NodeJS](https://nodejs.org/en/download/) version recommended: `16.14.0`  | 
 | 11 | +- Verify the Node.js version by opening Command Prompt/Terminal and running `node -v`  | 
 | 12 | +- Download Git [here](https://git-scm.com/downloads)  | 
 | 13 | +- [VS Code Editor](https://code.visualstudio.com/download)  | 
20 | 14 | 
 
  | 
21 | 15 | To build on your local:  | 
22 | 16 | 
 
  | 
23 | 17 | 1. Clone the repo using Git or tools like GitHub Desktop.  | 
24 |  | -2. In a terminal, change to the cloned repo folder. Run the install command: `npm install`.  | 
 | 18 | +2. In a terminal, change to the cloned repo folder. Run the install command: `npm install --legacy --peer-deps`.  | 
25 | 19 | 3. To serve and review your content, use one of the following:  | 
26 |  | -   * Use start, hot reloads as you make changes: `npm start`.   | 
 | 20 | +   - Use start, hot reloads as you make changes: `npm start`.   | 
27 | 21 | 4. To build locally and test your links, run `npm run build`. Any issues with broken links and images are listed according to file. Locate and update those issues, then run `npm serve` and start again to verify.  | 
28 | 22 | 
 
  | 
29 |  | -Note- If the command doesn't work, try `npm i react-scripts@latest` followed by `npm start`.  | 
 | 23 | +Note: If the command doesn't work, try `npm i react-scripts@latest` followed by `npm start`.  | 
30 | 24 | 
 
  | 
31 | 25 | The static files are generated in the build folder and run on your local machine at: http://localhost:3000/. To stop the build or served site, hit Ctrl + C to interrupt. You can enter new commands in terminal, rebuild, and restart.  | 
32 | 26 | 
 
  | 
33 | 27 | [LambdaTest Documentation](https://lambdatest.com/support/docs/) was created using [Docusaurus 2](https://docusaurus.io/) with React  | 
34 | 28 | 
 
  | 
35 | 29 | ## Publishing Content  | 
 | 30 | +- Clone the repository to your local machine  | 
 | 31 | +- Switch to the `stage` branch / you can create your desired branch as well.  | 
 | 32 | +- Now after completing your changes, raise the PR for the `stage` branch only and ask to the docs team to review and merge it for `stage`.  | 
 | 33 | +- Verify your changes on the stage domain.  | 
 | 34 | +- Now to deploy your changes to the PROD, provide all the PRs related to that feature to the docs team, they will merge it to PROD.  | 
36 | 35 | 
 
  | 
37 |  | -As pull requests are merged to the `main` branch by the [LambdaTest Documentation](https://lambdatest.com/support/docs/) team, the content builds and deploys to a staging site. This allows you to review and test your content thoroughly on a server, rather than a local build, prior to merging your code to production.  | 
 | 36 | +As pull requests are merged to the `main` branch by the [LambdaTest Documentation](https://lambdatest.com/support/docs/) team, the content builds and deploys to a staging site. This allows you to review and test your content thoroughly on a server, rather than a local build, prior to merging your code to production.  | 
0 commit comments