Flamingock Documentation
The official documentation source for Flamingock - the Change-as-Code platform
๐ View Documentation โข
๐ Main Repository โข
๐ Report Issue
About
This repository contains the source code for the Flamingock documentation site, built with Docusaurus.
Flamingock is a Change-as-Code platform that versions and orchestrates any state change that must evolve alongside your application:
- โ
Databases (SQL/NoSQL)
- โ
Message queues (Kafka, RabbitMQ)
- โ
Cloud storage (S3, GCS)
- โ
REST APIs & Webhooks
- โ
Feature flags & Configuration
- โ
Any external system
๐ค Contributing
We welcome contributions to improve our documentation! Whether you've found a typo, want to clarify a concept, or add a new guide, your help makes Flamingock better for everyone.
Quick Contribution Guide
- Found an issue? Open an issue describing what needs to be fixed
- Have a fix? Fork the repository and submit a pull request
- Major changes? Please open an issue first to discuss your proposed changes
Making Documentation Changes
- Fork and clone this repository
- Install dependencies:
yarn install
- Start local development:
yarn start
- Make your changes in the
docs/ directory
- Test your changes locally
- Submit a pull request
๐ Development
Prerequisites
- Node.js 18+
- Yarn package manager
Installation
# Clone the repository
git clone https://github.com/flamingock/flamingock.github.io.git
cd flamingock.github.io
# Install dependencies
yarn install
Local Development
# Start the development server
yarn start
This opens your browser to http://localhost:3000 with hot reload enabled. Most changes are reflected instantly.
Building
# Build static site
yarn build
# Test the build locally
yarn serve
๐ Documentation Structure
docs/
โโโ overview/ # Core concepts and introduction
โโโ quick-start/ # Getting started guides
โโโ changes/ # Change management documentation
โโโ target-systems/ # Target system configurations
โโโ audit-stores/ # Audit store implementations
โโโ templates/ # Template system documentation
โโโ frameworks/ # Framework integrations (Spring Boot, etc.)
โโโ testing/ # Testing strategies
โโโ cli/ # CLI documentation
๐ง Technical Stack
- Generator: Docusaurus 3.x
- Search: Algolia DocSearch
- Deployment: GitHub Pages
- Package Manager: Yarn
๐ Documentation Guidelines
When contributing documentation:
- Use clear, concise language
- Include code examples where helpful
- Follow the existing structure and formatting
- Test all code examples
- Update navigation in
sidebars.js if adding new pages
๐ Support
๐ Links
๐ License
This documentation is licensed under the Apache License 2.0.
Made with โค๏ธ by the Flamingock Team