Skip to content

Commit 1393b00

Browse files
committed
docs: clean up diagrams README - remove Draw.io references
- Remove all Draw.io instructions and links - Remove PNG export mentions - Remove editing tool instructions - Focus on Mermaid diagrams that render natively in GitHub - Simplify updating procedures
1 parent 84caef4 commit 1393b00

File tree

1 file changed

+21
-23
lines changed

1 file changed

+21
-23
lines changed

playbook/diagrams/README.md

Lines changed: 21 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,39 @@
11
# Infrastructure Diagrams
22

3-
This folder contains Draw.io diagrams for the Kainos Studio infrastructure architecture.
3+
This folder contains high-level architecture diagrams for the Kainos Studio infrastructure using Mermaid syntax for better visibility and version control.
44

55
## 📊 Available Diagrams
66

7-
### End-to-End Architecture
8-
- **[kainos-studio-architecture.drawio](./kainos-studio-architecture.drawio)** - Complete system architecture
9-
- **[kainos-studio-architecture.png](./kainos-studio-architecture.png)** - PNG export of architecture
7+
### High-Level Architecture
8+
- **[kainos-studio-architecture.md](./kainos-studio-architecture.md)** - Complete system architecture overview
109

11-
### Environment Flow Diagrams
12-
- **[dev-deployment-flow.drawio](./dev-deployment-flow.drawio)** - Development environment deployment flow
13-
- **[staging-deployment-flow.drawio](./staging-deployment-flow.drawio)** - Staging environment deployment flow
14-
- **[prod-deployment-flow.drawio](./prod-deployment-flow.drawio)** - Production environment deployment flow
10+
### Deployment Flow Diagrams
11+
- **[dev-deployment-flow.md](./dev-deployment-flow.md)** - Development environment deployment flow
12+
- **[staging-deployment-flow.md](./staging-deployment-flow.md)** - Staging environment deployment flow
13+
- **[prod-deployment-flow.md](./prod-deployment-flow.md)** - Production environment deployment flow
1514

16-
## 🎨 How to Edit Diagrams
15+
## 🎨 Viewing Diagrams
1716

18-
1. **Online**: Visit [draw.io](https://app.diagrams.net/) and open the `.drawio` files
19-
2. **VS Code**: Install the Draw.io Integration extension
20-
3. **Desktop**: Download Draw.io desktop application
17+
All Mermaid diagrams render directly in GitHub for easy viewing and collaboration.
2118

2219
## 📋 Diagram Standards
2320

24-
- Use AWS/Azure official icons from the shape libraries
21+
- Use consistent color coding:
22+
- Orange (#FF9900): AWS services
23+
- Blue (#0078D4): Azure services
24+
- Green (#28A745): Application components
25+
- Red (#DC3545): Security boundaries
26+
- Gray (#6C757D): External services
27+
2528
- Include environment labels (dev/staging/prod)
2629
- Show data flow directions with arrows
27-
- Include security boundaries and zones
28-
- Use consistent color coding:
29-
- Orange: AWS services
30-
- Blue: Azure services
31-
- Green: Application components
32-
- Red: Security boundaries
33-
- Gray: External services
30+
- Keep diagrams high-level and focused
31+
- Use meaningful component names
3432

3533
## 🔄 Updating Diagrams
3634

3735
When infrastructure changes:
38-
1. Update the relevant `.drawio` file
39-
2. Export as PNG for easy viewing
40-
3. Commit both files to version control
36+
1. Update the relevant `.md` file with Mermaid syntax
37+
2. Test rendering in GitHub
38+
3. Commit changes to version control
4139
4. Update this README if new diagrams are added

0 commit comments

Comments
 (0)