|
1 | | -# ToThis is a deploymThese principles should guide all development decisions, code reviews, and feature implementations. |
2 | | - |
3 | | -## 🏗️ Tech Stack infrastructure proof-of-concept for the Torrust ecosystem. It uses OpenTofu (Terraform), Ansible, and Rust to provision and manage deployment environments with LXD containers and Multipass VMs. |
4 | | - |
5 | | -## 🎯 Essential Principles |
6 | | - |
7 | | -The development of this application is guided by fundamental principles that ensure quality, maintainability, and user experience. For detailed information, see [`docs/development-principles.md`](../docs/development-principles.md). Tracker Deploy - AI Assistant Instructions |
| 1 | +Tracker Deploy - AI Assistant Instructions |
8 | 2 |
|
9 | 3 | ## 📋 Project Overview |
10 | 4 |
|
11 | | -This is a deployment infrastructure proof-of-concept for the Torrust ecosystem. It uses OpenTofu (Terraform), Ansible, and Rust to provision and manage deployment environments with LXD containers and Multipass VMs. |
12 | | - |
13 | | -## � Essential Principles |
14 | | - |
15 | | -The development of this application is guided by fundamental principles that ensure quality, maintainability, and user experience. For detailed information, see [`docs/development-principles.md`](../docs/development-principles.md). |
16 | | - |
17 | | -**Core Principles:** |
| 5 | +This is a deployment infrastructure proof-of-concept for the Torrust ecosystem. It uses OpenTofu (Terraform), Ansible, and Rust to provision and manage deployment environments with LXD VM instances. |
18 | 6 |
|
19 | | -- **Observability**: If it happens, we can see it - even after it happens (includes deep traceability) |
20 | | -- **Testability**: Every component must be testable in isolation and as part of the whole |
21 | | -- **User Friendliness**: All errors must be clear, informative, and solution-oriented |
22 | | -- **Actionability**: The system must always tell users how to continue with detailed instructions |
23 | | - |
24 | | -These principles should guide all development decisions, code reviews, and feature implementations. |
25 | | - |
26 | | -## �🏗️ Tech Stack |
| 7 | +## 🏗️ Tech Stack |
27 | 8 |
|
28 | 9 | - **Languages**: Rust, Shell scripts, YAML, TOML |
29 | 10 | - **Infrastructure**: OpenTofu (Terraform), Ansible |
@@ -51,6 +32,19 @@ These principles should guide all development decisions, code reviews, and featu |
51 | 32 | - `cspell.json` - Spell checking configuration |
52 | 33 | - `project-words.txt` - Project-specific dictionary |
53 | 34 |
|
| 35 | +## Essential Principles |
| 36 | + |
| 37 | +The development of this application is guided by fundamental principles that ensure quality, maintainability, and user experience. For detailed information, see [`docs/development-principles.md`](../docs/development-principles.md). |
| 38 | + |
| 39 | +**Core Principles:** |
| 40 | + |
| 41 | +- **Observability**: If it happens, we can see it - even after it happens (includes deep traceability) |
| 42 | +- **Testability**: Every component must be testable in isolation and as part of the whole |
| 43 | +- **User Friendliness**: All errors must be clear, informative, and solution-oriented |
| 44 | +- **Actionability**: The system must always tell users how to continue with detailed instructions |
| 45 | + |
| 46 | +These principles should guide all development decisions, code reviews, and feature implementations. |
| 47 | + |
54 | 48 | ## 🔧 Essential Rules |
55 | 49 |
|
56 | 50 | 1. **Before creating branches**: Read [`docs/contributing/branching.md`](../docs/contributing/branching.md) for naming conventions (`{issue-number}-{short-description}`) |
|
0 commit comments