Skip to content

Commit 319b48d

Browse files
authored
Merge pull request #2202 from Ishavyas9/main
HYP doc updated
2 parents 9824da4 + c6fc88e commit 319b48d

8 files changed

+1523
-47
lines changed

README.md

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,36 @@
11
# [LambdaTest Documentation](https://lambdatest.com/support/docs/)
2-
32
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.
43

5-
---
6-
7-
84
## Contributing Content
9-
105
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.
116

127
## Building Locally
13-
148
Docusaurus requires the following to build on locals:
159

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)
2014

2115
To build on your local:
2216

2317
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`.
2519
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`.
2721
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.
2822

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`.
3024

3125
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.
3226

3327
[LambdaTest Documentation](https://lambdatest.com/support/docs/) was created using [Docusaurus 2](https://docusaurus.io/) with React
3428

3529
## 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.
3635

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

Comments
 (0)