Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update npm start command to run make docs #1440

Merged
merged 5 commits into from
Jan 12, 2024
Merged

Update npm start command to run make docs #1440

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f107a82
Update npm start command to run make docs
heitortsergent Dec 4, 2023
7ba42cd
Merge branch 'main' into chore/update-npm-start
heitortsergent Dec 7, 2023
15ef0ae
chore: rename start-gatsby to start:gatsby
heitortsergent Jan 11, 2024
a1568f0
chore: update README and CONTRIBUTING
heitortsergent Jan 11, 2024
f5e6f3f
Merge branch 'main' into chore/update-npm-start
heitortsergent Jan 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions CONTRIBUTING/README.md
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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
Loading