Skip to content

Commit

Permalink
changes to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
akyriako committed Jul 12, 2024
1 parent bf10cce commit fbca639
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,24 @@ npm run start

This command starts a local development server and opens up a browser window. Changes are reflected live without having to restart the server.

> [!IMPORTANT]
> docs-next functionality is tightly integrated with typesense (as long as you want to work with search in your development enviroment). No typesense
> installation is provided out-of-the-box, you need to come with you own instance. A Helm Chart is already provided for that matter and you can easily
> install a typesense-bundle in your local enviroment using KinD:
>
> ```shell
> helm repo add docs-next https://akyriako.github.io/docs-next-charts
> helm repo update
>
> helm upgrade --install docs-next docs-next/typesense \
> --set typesenseReverseProxy.elbid = <typesense-reverse-proxy elastic load balancer id> \
> --set typesenseReverseProxy.host = <typesense-reverse-proxy fqdn> \
> --set docusaurus.host = <docs-next fqdn> \
> --set apiKeys.typesenseApiKey = <admin-api-key> \
> -n docs-next-preview \
> --create-namespace
> ```
### Build and Run in Production
```
Expand Down

0 comments on commit fbca639

Please sign in to comment.