[docs]: Added instructions for using npm to run the Docusaurus site l…

…ocally (#423)

* docs(configuration): added example for handling nested JSON fields

Added example for handling nested JSON fields

Closes #1892

Signed-off-by: GauriBhandari <[email protected]>

* docs: add instructions for using npm to run the Docusaurus site locally

Added instructions for using npm to run the Docusaurus site locally

Closes #2094

Signed-off-by: Gauri Bhandari <[email protected]>
Signed-off-by: GauriBhandari <[email protected]>

* docs: add instructions for using npm to run the Docusaurus site locally

Added note

Closes #2094

Signed-off-by: Gauri Bhandari <[email protected]>
Signed-off-by: GauriBhandari <[email protected]>

* Updated documentation to reflect npm migration

Revised the documentation to include instructions for using npm instead of yarn

Migration from using yarn to npm on docs website

Closes #2094

Signed-off-by: Gauri Bhandari <[email protected]>
Signed-off-by: GauriBhandari <[email protected]>

* docs: update npm migration instructions

Revised the documentation to include instructions for using npm instead of yarn. This change reflects the migration from using yarn to npm for building, testing, and deploying the docs website.

Closes #2094

Signed-off-by: GauriBhandari <[email protected]>

* ci: update lint.yml to ensure proper commit message formatting

This commit updates the lint.yml file to ensure that commit messages follow the required format.

Closes #2094

Signed-off-by: Gauri Bhandari <[email protected]>
Signed-off-by: GauriBhandari <[email protected]>

* docs: update npm migration instructions

Closes #2094

Signed-off-by: Gauri Bhandari <[email protected]>
Signed-off-by: GauriBhandari <[email protected]>

* docs: update installation instructions for npm migration

Revised the documentation to reflect the migration from Yarn to npm for building, testing, and deploying the docs website.

Closes #2094

Signed-off-by: GauriBhandari <[email protected]>

---------

Signed-off-by: GauriBhandari <[email protected]>
Signed-off-by: Gauri Bhandari <[email protected]>
Co-authored-by: Animesh Pathak <[email protected]>

.github/workflows/build_and_check.yml

@@ -20,11 +20,8 @@ jobs:
         with:
           node-version: 18.0.0
 
-      - name: Install Yarn
-        run: npm install -g yarn
-
       - name: Install Dependencies
-        run: yarn install
+        run: npm install
 
       - name: Build Documentation
-        run: yarn build
+        run: npm run build

.github/workflows/lint.yml

@@ -15,6 +15,14 @@ jobs:
         with:
           fetch-depth: 0
 
+      - name: Set up Node.js
+        uses: actions/setup-node@v2
+        with:
+          node-version: '18.0.0'
+
+      - name: Install Dependencies
+        run: npm install
+
       - name: Check commits messages
         uses: wagoid/commitlint-github-action@v5
         env:

README.md

@@ -64,12 +64,13 @@ The Keploy documentation site uses [Docusaurus 2](https://v2.docusaurus.io/), wh
 You can make changes locally without previewing them in the browser.
 However, if you want to build the site and preview changes in the browser, you need to have [Docusaurus 2 dependencies](https://v2.docusaurus.io/docs/installation/#requirements) installed.
 
-Initialize Docusaurus 2 in the repo by running [`yarn`](https://classic.yarnpkg.com/en/docs/cli/) once in the root directory of the repo.
+Initialize Docusaurus 2 in the repo by running [`npm`](https://docs.npmjs.com/cli/v7/commands/npm-install) once in the root directory of the repo.
 
 Now you can build and view the site locally:
 
 ```bash
-yarn start
+npm install
+npm start
 ```
 
 The command starts a local development server and opens a browser window.
@@ -95,17 +96,17 @@ cd docs
 3. Install all the dependencies
 
 ```sh
-yarn install
+npm install
 
 ## Start the development server.
 
-yarn start
+npm start
 ```
 
 4. To reformat:
 
 ```sh
-yarn prettier --write '**/*.{js,md}'
+npm prettier --write '**/*.{js,md}'
 ```
 
 5. Check the build status:

versioned_docs/version-2.0.0/keploy-explained/docs-dev-guide.md

@@ -29,18 +29,30 @@ The Keploy documentation site uses [Docusaurus 2](https://v2.docusaurus.io/), wh
 You can make changes locally without previewing them in the browser.
 However, if you want to build the site and preview changes in the browser, you need to have [Docusaurus 2 dependencies](https://v2.docusaurus.io/docs/installation/#requirements) installed.
 
-Initialize Docusaurus 2 in the repo by running [`yarn`](https://classic.yarnpkg.com/en/docs/cli/) once in the root directory of the repo.
+Initialize Docusaurus 2 in the repo by running [`yarn`](https://classic.yarnpkg.com/en/docs/cli/) or [`npm`](https://docs.npmjs.com/cli/v10) once in the root directory of the repo.
 
 Now you can build and view the site locally:
 
+
+```shell
+npm start
+```
+
+or 
+
 ```shell
 yarn start
 ```
 
+
 The command starts a local development server and opens a browser window.
 
 ## Prettier
 
+**Note: The website has been migrated to use `npm` for building, testing, and deploying.**
+
+Steps 1 to 3 are the same for both `yarn` and `npm` 
+
 1. Fork the repository
 
 2. Clone the repository with the following command. Replace the {'<'}GITHUB_USERNAME{'>'} with your username
@@ -55,6 +67,29 @@ git clone https://github.com/<GITHUB_USERNAME>/docs.git
 cd docs
 ```
 
+### Using `npm` 
+
+4. Install all the dependencies
+
+```shell
+npm install
+```
+
+5. Start the development server.
+
+```shell
+npm start
+```
+
+6. To reformat:
+
+```shell
+npm prettier --write '**/*.{js,md}'
+```
+
+
+### Using `yarn` (Legacy)       
+
 4. Install all the dependencies
 
 ```shell
@@ -73,6 +108,7 @@ yarn start
 yarn prettier --write '**/*.{js,md}'
 ```
 
+
 When we merge your PR, a new build automatically occurs and your changes publish to [https://docs.keploy.io](https://docs.keploy.io).
 
 ## How to Contribute Code?