Aiven docs

The Aiven docs repo generates the content located at www.aiven.io/docs. We use Docusaurus to build the docs.

🤲 Contributing

We welcome contributions! To contribute to our docs, see Contributing.

️🚀 Building the docs

Requirements

Node ≥ 22
yarn 4

Install the dependencies:
```
corepack enable
yarn
```
Optional: Install Vale.
Optional: Install Husky:
```
yarn dlx husky
```
Husky prevents git pushes when Vale erros are in the files you've modified.
Build the docs:
```
yarn start
```
A local development server starts and a browser window opens. Modify the content and save to automatically refresh the output.

💡 Tip:
- If you use VS Code, you can use the build task: ⌘+⇧+B > Build the docs
☝ ️Caution:
- yarn start doesn't check for broken links, use yarn build instead. This command doesn't start a live server.
When you are happy with your changes, open a PR.