Skip to content

Commit

Permalink
Fix website README
Browse files Browse the repository at this point in the history
The new environment variable ALGOLIA_API_KEY hasn't been added to the
documentation in the README so I added it and also simplified the
command to run the dev server.

Signed-off-by: Max Jonas Werner <[email protected]>
  • Loading branch information
Max Jonas Werner authored and enekofb committed Nov 14, 2023
1 parent 8b6addb commit d8deb47
Showing 1 changed file with 2 additions and 4 deletions.
6 changes: 2 additions & 4 deletions website/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,6 @@ The website is live [here](https://docs.gitops.weave.works/).

1. Install dependencies: `yarn install`.

1. Set a fake Google Analytics API key to pass validation errors: `export GA_KEY=fakekey`

1. Start the docs server.

> If you are using newer version of Node (17+):
Expand All @@ -24,7 +22,7 @@ The website is live [here](https://docs.gitops.weave.works/).
> ```
```bash
yarn start
GA_KEY=fake ALGOLIA_API_KEY=fake yarn start
```
This will open a browser window. Your changes will be automatically loaded by
Expand Down Expand Up @@ -178,4 +176,4 @@ Deployment happens automatically (once the tests pass) upon merging to the
This section lists commonly used terms in the docs in an effort to promote consistency.
- `Leaf clusters`: used in Weave GitOps Enterprise to describe any CAPI or non-CAPI clusters that appear in the `Clusters` section of the UI. Typically, these clusters are running application workloads.
- `Leaf clusters`: used in Weave GitOps Enterprise to describe any CAPI or non-CAPI clusters that appear in the `Clusters` section of the UI. Typically, these clusters are running application workloads.

0 comments on commit d8deb47

Please sign in to comment.