|
| 1 | +# Introduction |
| 2 | +- Overview: Brief introduction to Flamingock, its evolution from Mongock, and its cloud-native focus. |
| 3 | +- Key Features: Highlight the most important features (Auditing & Rollback, Cloud-Native, Extended System Support, etc.). |
| 4 | +- Use Cases: Practical examples of where Flamingock can be applied (e.g., database versioning, configuration management, etc.). |
| 5 | + |
| 6 | +# Concepts |
| 7 | +- Change Units & Auditing: Explanation of how Flamingock handles changes and versions across systems. |
| 8 | +- Runner: Explain the runner. |
| 9 | +- Driver: Explain Driver |
| 10 | +- Cloud: Explain cloud mechanism |
| 11 | +- Rollback: Detailed explanation of auditing features and rollback mechanisms, including how to query and restore previous states. |
| 12 | +- Workflows and stages: Overview of Flamingock's advanced workflow management, including sequential, parallel, and combined workflows, and stages |
| 13 | +- Template: Explanation of templates. |
| 14 | +- Distributed Locking: How Flamingock handles synchronization and locking in distributed environments. |
| 15 | +Etc. |
| 16 | + |
| 17 | +# Getting Started |
| 18 | +- Installation: Guide for setting up Flamingock cloud and client, including both cloud and fallback local driver options. |
| 19 | +- Quick Start Guide: A hands-on tutorial for quickly integrating Flamingock into an existing project or system. |
| 20 | +- Configuration: Configuration options for setting up Flamingock, including environment variables and default settings. |
| 21 | + |
| 22 | +# Architectural overview |
| 23 | +- Provide the architectural overview with the cloud integration |
| 24 | +- Transaction Handling: How transactions are managed to ensure data integrity in the cloud. |
| 25 | +- Maybe, showing with a secondry focus, the integration with local driver as an alternative |
| 26 | + |
| 27 | +# Runners |
| 28 | +- Standalone: Explain standalone runner |
| 29 | +- Spring Boot v3: Explain Spring Boot v3 runner |
| 30 | +- Spring Boot v3: Explain Spring Boot v4 runner |
| 31 | + |
| 32 | +# Templates |
| 33 | +- Explain |
| 34 | + |
| 35 | +# Features |
| 36 | +- GraalVM: Explanation of how Flamingock handles changes and versions across systems. |
| 37 | +- Workflows: Explanation workflows and stages |
| 38 | +- Custom injections |
| 39 | +- Transactions |
| 40 | +- Events |
| 41 | +- Multitenant |
| 42 | +- Etc |
| 43 | + |
| 44 | +# Testing |
| 45 | +- Explain |
| 46 | + |
| 47 | +# CLI |
| 48 | +- Explain |
| 49 | + |
| 50 | +# Local drivers |
| 51 | +- MongoDB V3 |
| 52 | +- MongoDB Sync4 |
| 53 | +- MongoDB Spring Data V2 |
| 54 | +- etc |
| 55 | + |
| 56 | +# Resources |
| 57 | +- Explains |
| 58 | + |
| 59 | + |
| 60 | +# Migration from Mongock |
| 61 | +- Explains |
| 62 | + |
| 63 | +# FAQ |
| 64 | +- Explains |
| 65 | + |
| 66 | +# Contributing |
| 67 | +- Explains |
| 68 | + |
| 69 | +# Changelog |
| 70 | +- History of changes or links to github releases. We need to keep also the updated about new features and changes in the server |
0 commit comments