Official documentation repository for Civo - Built for More.
Found a typo? Have a better explanation? Want to add missing information?
We'd love your help! This documentation is open source, and contributions of all sizes are welcome and appreciated. Whether you're fixing a single typo or adding an entire page, your contribution helps the Civo community.
- Small changes (typos, clarifications, updates): Click the "Edit this page" button at the bottom of any docs page, or use GitHub's web editor to make changes directly in your browser. No local setup needed!
- Larger contributions: Clone this repo, run
yarn startto preview your changes locally, then submit a pull request
Every markdown file in the content/docs/ directory is a documentation page you can improve. Don't worry about making mistakes - all changes are reviewed before being published.
📖 Read our Contributing Guidelines for more details and best practices.
This repository contains the source files that power the documentation site at https://www.civo.com/docs.
The documentation covers all aspects of the Civo cloud platform:
- Kubernetes - Managed Kubernetes clusters
- Compute - Virtual machine instances
- Databases - Managed database services (PostgreSQL, MySQL, Redis)
- Networking - Load balancers, firewalls, and networking features
- Object Storage - S3-compatible object storage
- Account Management - Billing, teams, and account settings
Want to preview your changes or contribute larger updates? Here's how to run the docs locally:
- Node.js >= 16.14 (check with
node --version) - npm (comes with Node.js)
- Yarn package manager
- Clone the repository:
git clone https://github.com/civo/docs.git
cd docs- Install Yarn globally (if not already installed):
npm install --global yarn- Install dependencies:
yarnStart the development server with live reload:
yarn startOpens http://localhost:3000 - changes are reflected instantly!
Build static files for production:
yarn buildPreview the production build locally:
yarn serveClear cache (useful if something seems broken):
yarn cleardocs/
├── content/ # All documentation content (edit these!)
│ └── docs/
│ ├── account/ # Account management docs
│ ├── compute/ # Compute instance docs
│ ├── database/ # Database service docs
│ ├── kubernetes/ # Kubernetes docs
│ ├── networking/ # Networking docs
│ ├── object-stores/# Object storage docs
│ └── ...
├── src/ # Custom React components and CSS
├── static/ # Static assets (images, files)
├── docusaurus.config.js # Site configuration
├── sidebars.js # Navigation structure
└── package.json # Dependencies and scripts
When contributing, please keep these guidelines in mind:
- Format: Use Markdown with Docusaurus extensions (tabs, admonitions, etc.)
- Images: Optimize file sizes and ensure text is legible
- Code: Use code blocks for commands and terminal output (not screenshots)
- Scope: Keep pull requests focused on a single topic or fix
- New topics: Open an issue first to discuss whether it's better as docs or a tutorial
- Docusaurus 2 - Modern static website generator
- React - UI library
- MDX - Markdown with JSX support
- Typesense - Search functionality
- Documentation issues: Open an Issue or submit a PR
- Civo platform support: Visit Civo Support
- Community: Join discussions on the Civo Community Slack
Changes merged to the main branch are automatically deployed to www.civo.com/docs through our CI/CD pipeline.
Thank you for helping make Civo's documentation better for everyone! 💙