josecordaz / weave-gitops-docs

GitOps documentation repo

Website

This website is built using Docusaurus 2, a modern static website generator.

Installation

yarn install

Local Development

Set a fake Algolia API key to pass validation errors:

export ALGOLIA_API_KEY=fakekey

yarn start

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

Build

yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

Deployment happens automatically (once the tests pass) upon merging to the default branch: see .github/workflows/documentation.yml for config.