Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
13 changes: 6 additions & 7 deletions .github/workflows/continuous-delivery.yml
Original file line number Diff line number Diff line change
Expand Up @@ -34,23 +34,22 @@ jobs:
- name: Setup Node
uses: actions/setup-node@949feb2413d6458794dcd2491c4babbbce0c15c1 # v7
with:
# Use the latest LTS version of Node.js already installed on the runner.
node-version: latest
check-latest: 'false'
cache: yarn
cache-dependency-path: website/yarn.lock
# Use the latest Node.js LTS release.
node-version: lts/*
cache: npm
cache-dependency-path: website/package-lock.json

- name: Setup Pages
if: github.ref == 'refs/heads/main'
uses: actions/configure-pages@45bfe0192ca1faeb007ade9deae92b16b8254a0d # v6

- name: Install dependencies
working-directory: website
run: yarn install --frozen-lockfile --non-interactive
run: npm ci

- name: Build website
working-directory: website
run: yarn build
run: npm run build

- name: Upload artifact
if: github.ref == 'refs/heads/main'
Expand Down
3 changes: 0 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -45,9 +45,6 @@ go.work
.env.production.local

npm-debug.log*
yarn-debug.log*
yarn-error.log*
package-lock.json

# Build and cache
.cache/
Expand Down
4 changes: 2 additions & 2 deletions Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@ FROM node:lts-alpine@sha256:c6ad9e9c1d80f6eb607c26b4b0a132ff7a2344fad1c78ea3baa2
COPY website /website

WORKDIR /website
RUN yarn
RUN npm ci

CMD ["yarn", "start", "-h", "0.0.0.0"]
CMD ["npm", "run", "start", "--", "-h", "0.0.0.0"]
20 changes: 11 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,16 +39,18 @@ This website is built using [Docusaurus](https://docusaurus.io/), a modern stati

## Installation

Enter the `website` folder, then run:
All the commands below must be run from the `website` folder (that is where
`package.json` lives, not the repository root):

```bash
yarn
cd website
npm install
```

## Local Development

```bash
yarn start
npm run start
```

This command starts a local development server and opens up a browser window.
Expand All @@ -57,7 +59,7 @@ Most changes are reflected live without having to restart the server.
## Build

```bash
yarn build
npm run build
```

This command generates static content into the `build` directory and can be
Expand All @@ -66,12 +68,12 @@ served using any static contents hosting service.
## Testing Production Features

Some features, like redirects, only work in production builds and are not
available during local development (`yarn start`). To test these features
available during local development (`npm run start`). To test these features
locally:

```bash
yarn build
yarn serve
npm run build
npm run serve
```

This builds the site and serves it locally, allowing you to test production-only
Expand All @@ -82,13 +84,13 @@ features.
Using SSH:

```bash
USE_SSH=true yarn deploy
USE_SSH=true npm run deploy
```

Not using SSH:

```bash
GIT_USER=<Your GitHub username> yarn deploy
GIT_USER=<Your GitHub username> npm run deploy
```

If you are using GitHub pages for hosting, this command is a convenient way to
Expand Down
2 changes: 1 addition & 1 deletion renovate.json
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
{
"matchFileNames": [
"website/package.json",
"website/yarn.lock"
"website/package-lock.json"
],
"groupName": "documentation dependencies"
}
Expand Down
Loading
Loading