/aiven-docs

The repository for the public documentation.

Primary LanguagePLpgSQLApache License 2.0Apache-2.0

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

  1. Install the dependencies:

    yarn

  2. Build the docs:

    yarn start

    Note: If you use VS Code, use the build task: ⌘+⇧+B > Build the docs

    A local development server starts and a browser window opens. Modify the content and save to automatically refresh the output.

  3. Check the CLI output for broken links.

  4. When you are happy with your changes, open a PR.