Skip to content

Commit

Permalink
Update npm start command to run make docs (#1440)
Browse files Browse the repository at this point in the history
* Update npm start command to run make docs

* chore: rename start-gatsby to start:gatsby

* chore: update README and CONTRIBUTING
  • Loading branch information
heitortsergent committed Jan 12, 2024
1 parent 10929f4 commit 02b46d1
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 6 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,10 +47,10 @@ Clone the repository to your machine:
git clone https://github.com/grafana/k6-docs.git
```

Navigate to the `docs` directory and run `make docs`:
Run `npm start`:

```bash
cd docs && make docs
npm start
```

You should see an output similar to this when the site finishes building:
Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING/legacy-gatsby-docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ To build locally:
4. Run the docs locally.

```bash
npm start # or yarn start
npm run start:gatsby
```

If everything works, a live preview should be serving on http://localhost:8000.
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,10 +52,10 @@ Clone the repository to your machine:
git clone https://github.com/grafana/k6-docs.git
```

Navigate to the `docs` directory and run `make docs`:
Run `npm start`:

```bash
cd docs && make docs
npm start
```

You should see an output similar to this when the site finishes building:
Expand Down
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@
"build:incremental": "GATSBY_EXPERIMENTAL_PAGE_BUILD_ON_DATA_CHANGES=true gatsby build --prefix-paths --log-pages",
"build": "npm run build:gatsby",
"clean": "gatsby clean",
"start": "npm run develop --host=0.0.0.0",
"start": "cd docs && make docs",
"start:gatsby": "npm run develop --host=0.0.0.0",
"serve": "gatsby serve --prefix-paths",
"deploy": "./scripts/gatsby-s3-workaround.sh prepare && gatsby-plugin-s3 deploy --yes && ./scripts/cloudfront-invalidate.sh && ./scripts/gatsby-s3-workaround.sh revert",
"predevelop": "shx test -f ./.env.development || shx cp ./.env.example ./.env.development",
Expand Down

0 comments on commit 02b46d1

Please sign in to comment.