Skip to content

Commit 02b46d1

Browse files
Update npm start command to run make docs (#1440)
* Update npm start command to run make docs * chore: rename start-gatsby to start:gatsby * chore: update README and CONTRIBUTING
1 parent 10929f4 commit 02b46d1

File tree

4 files changed

+7
-6
lines changed

4 files changed

+7
-6
lines changed

CONTRIBUTING/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,10 +47,10 @@ Clone the repository to your machine:
4747
git clone https://github.com/grafana/k6-docs.git
4848
```
4949

50-
Navigate to the `docs` directory and run `make docs`:
50+
Run `npm start`:
5151

5252
```bash
53-
cd docs && make docs
53+
npm start
5454
```
5555

5656
You should see an output similar to this when the site finishes building:

CONTRIBUTING/legacy-gatsby-docs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ To build locally:
6666
4. Run the docs locally.
6767

6868
```bash
69-
npm start # or yarn start
69+
npm run start:gatsby
7070
```
7171

7272
If everything works, a live preview should be serving on http://localhost:8000.

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,10 +52,10 @@ Clone the repository to your machine:
5252
git clone https://github.com/grafana/k6-docs.git
5353
```
5454

55-
Navigate to the `docs` directory and run `make docs`:
55+
Run `npm start`:
5656

5757
```bash
58-
cd docs && make docs
58+
npm start
5959
```
6060

6161
You should see an output similar to this when the site finishes building:

package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,8 @@
1212
"build:incremental": "GATSBY_EXPERIMENTAL_PAGE_BUILD_ON_DATA_CHANGES=true gatsby build --prefix-paths --log-pages",
1313
"build": "npm run build:gatsby",
1414
"clean": "gatsby clean",
15-
"start": "npm run develop --host=0.0.0.0",
15+
"start": "cd docs && make docs",
16+
"start:gatsby": "npm run develop --host=0.0.0.0",
1617
"serve": "gatsby serve --prefix-paths",
1718
"deploy": "./scripts/gatsby-s3-workaround.sh prepare && gatsby-plugin-s3 deploy --yes && ./scripts/cloudfront-invalidate.sh && ./scripts/gatsby-s3-workaround.sh revert",
1819
"predevelop": "shx test -f ./.env.development || shx cp ./.env.example ./.env.development",

0 commit comments

Comments
 (0)