https://github.com/aiven/aiven-docs
The repository for the public documentation.
https://github.com/aiven/aiven-docs
docs documentation
Last synced: 6 months ago
JSON representation
The repository for the public documentation.
- Host: GitHub
- URL: https://github.com/aiven/aiven-docs
- Owner: aiven
- License: apache-2.0
- Created: 2024-01-08T09:16:30.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-12-20T09:16:03.000Z (6 months ago)
- Last Synced: 2025-12-22T03:08:29.150Z (6 months ago)
- Topics: docs, documentation
- Language: TypeScript
- Homepage: https://aiven.io/docs
- Size: 53.6 MB
- Stars: 19
- Watchers: 45
- Forks: 25
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
# Aiven docs
The Aiven docs repo generates the content located at [www.aiven.io/docs](https://www.aiven.io/docs).
We use [Docusaurus](https://docusaurus.io/) to build the docs.
## 🤲 Contributing
We welcome contributions! To contribute to our docs, see [Contributing](./CONTRIBUTING.md).
## ️🚀 Building the docs
1. Update the examples submodule:
```bash
git submodule update --init --recursive
```
### With Docker
1. Run:
```bash
docker compose up dev
```
1. Go to http://localhost:3000/docs/. Updating files in your local repo refreshes the website.
### Without Docker
Requirements
1. Install the dependencies:
```bash
corepack enable
yarn
```
1. Optional: Install [Vale](https://vale.sh/docs/vale-cli/installation/).
1. Optional: Install [Husky](https://typicode.github.io/husky/):
```bash
yarn dlx husky
```
Husky prevents git pushes when Vale errors are in the files you've modified.
1. Build the docs:
```bash
yarn start
```
**💡 Tip:** If you use VS Code, you can use the build task: **⌘+⇧+B** > **Build the docs**
1. Go to http://localhost:3000/docs/. Updating files in the local repo refreshes the website.
## Opening a PR
1. Check for potential broken links with `yarn build` (`yarn start` doesn't check for broken links).
1. If you get a green build and when you are happy with your changes, open a PR.