Complete markdown files cleanup and organization
- Organized 252 files across project - Root directory: 187 → 2 files (98.9% reduction) - Moved configuration guides to docs/04-configuration/ - Moved troubleshooting guides to docs/09-troubleshooting/ - Moved quick start guides to docs/01-getting-started/ - Moved reports to reports/ directory - Archived temporary files - Generated comprehensive reports and documentation - Created maintenance scripts and guides All files organized according to established standards.
This commit is contained in:
defiQUG
233
docs/DOCUMENTATION_RELATIONSHIP_MAP.md
Normal file
233
docs/DOCUMENTATION_RELATIONSHIP_MAP.md
Normal file
@@ -0,0 +1,233 @@
|
||||
# Documentation Relationship Map
|
||||
|
||||
**Last Updated:** 2025-01-20
|
||||
**Document Version:** 1.0
|
||||
**Status:** Active Documentation
|
||||
|
||||
---
|
||||
|
||||
## Overview
|
||||
|
||||
This document provides a visual map of relationships between documentation files, showing dependencies, navigation paths, and document hierarchies.
|
||||
|
||||
---
|
||||
|
||||
## Documentation Relationship Graph
|
||||
|
||||
```mermaid
|
||||
graph TB
|
||||
MasterIndex[MASTER_INDEX.md<br/>Central Index]
|
||||
|
||||
subgraph GettingStarted[01-getting-started]
|
||||
StartHere[README_START_HERE.md]
|
||||
Prereqs[PREREQUISITES.md]
|
||||
end
|
||||
|
||||
subgraph Architecture[02-architecture]
|
||||
NetworkArch[NETWORK_ARCHITECTURE.md<br/>Authoritative]
|
||||
Orchestration[ORCHESTRATION_DEPLOYMENT_GUIDE.md]
|
||||
Hardware[PHYSICAL_HARDWARE_INVENTORY.md]
|
||||
VMID[VMID_ALLOCATION_FINAL.md]
|
||||
Domain[DOMAIN_STRUCTURE.md]
|
||||
Cluster[PROXMOX_CLUSTER_ARCHITECTURE.md]
|
||||
end
|
||||
|
||||
subgraph Deployment[03-deployment]
|
||||
DeploymentReadiness[DEPLOYMENT_READINESS.md]
|
||||
OperationalRunbooks[OPERATIONAL_RUNBOOKS.md]
|
||||
BackupRestore[BACKUP_AND_RESTORE.md]
|
||||
DisasterRecovery[DISASTER_RECOVERY.md]
|
||||
end
|
||||
|
||||
subgraph Configuration[04-configuration]
|
||||
ER605Config[ER605_ROUTER_CONFIGURATION.md]
|
||||
ConfigTree[CONFIGURATION_DECISION_TREE.md]
|
||||
subgraph Cloudflare[cloudflare]
|
||||
CloudflareZeroTrust[CLOUDFLARE_ZERO_TRUST_GUIDE.md]
|
||||
CloudflareRouting[CLOUDFLARE_ROUTING_MASTER.md]
|
||||
end
|
||||
end
|
||||
|
||||
subgraph Network[05-network]
|
||||
NetworkRouting[CLOUDFLARE_ROUTING_MASTER.md]
|
||||
NginxRouting[CENTRAL_NGINX_ROUTING_SETUP.md]
|
||||
TunnelRouting[CLOUDFLARE_TUNNEL_ROUTING_ARCHITECTURE.md]
|
||||
end
|
||||
|
||||
subgraph Besu[06-besu]
|
||||
BesuConfig[CHAIN138_BESU_CONFIGURATION.md]
|
||||
BesuStartup[BESU_NODE_STARTUP_SEQUENCE.md]
|
||||
BesuAllowlist[BESU_ALLOWLIST_RUNBOOK.md]
|
||||
end
|
||||
|
||||
subgraph Troubleshooting[09-troubleshooting]
|
||||
TroubleshootingFAQ[TROUBLESHOOTING_FAQ.md]
|
||||
TroubleshootingTree[TROUBLESHOOTING_DECISION_TREE.md]
|
||||
end
|
||||
|
||||
subgraph QuickRef[12-quick-reference]
|
||||
NetworkQR[NETWORK_QUICK_REFERENCE.md]
|
||||
VMIDQR[VMID_QUICK_REFERENCE.md]
|
||||
CommandsQR[COMMANDS_QUICK_REFERENCE.md]
|
||||
TroubleshootingQR[TROUBLESHOOTING_QUICK_REFERENCE.md]
|
||||
end
|
||||
|
||||
MasterIndex --> StartHere
|
||||
MasterIndex --> NetworkArch
|
||||
MasterIndex --> Orchestration
|
||||
|
||||
StartHere --> Prereqs
|
||||
StartHere --> NetworkArch
|
||||
|
||||
NetworkArch --> Hardware
|
||||
NetworkArch --> VMID
|
||||
NetworkArch --> Domain
|
||||
NetworkArch --> Cluster
|
||||
NetworkArch --> ER605Config
|
||||
|
||||
Orchestration --> NetworkArch
|
||||
Orchestration --> DeploymentReadiness
|
||||
Orchestration --> OperationalRunbooks
|
||||
|
||||
DeploymentReadiness --> ConfigTree
|
||||
DeploymentReadiness --> NetworkArch
|
||||
|
||||
ER605Config --> ConfigTree
|
||||
ConfigTree --> NetworkArch
|
||||
|
||||
CloudflareZeroTrust --> CloudflareRouting
|
||||
CloudflareRouting --> TunnelRouting
|
||||
CloudflareRouting --> NginxRouting
|
||||
|
||||
NetworkRouting --> TunnelRouting
|
||||
NetworkRouting --> NginxRouting
|
||||
|
||||
BesuConfig --> BesuStartup
|
||||
BesuConfig --> BesuAllowlist
|
||||
|
||||
TroubleshootingFAQ --> TroubleshootingTree
|
||||
TroubleshootingTree --> NetworkArch
|
||||
TroubleshootingTree --> BesuConfig
|
||||
|
||||
NetworkQR --> NetworkArch
|
||||
VMIDQR --> VMID
|
||||
CommandsQR --> OperationalRunbooks
|
||||
TroubleshootingQR --> TroubleshootingFAQ
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Document Dependency Chains
|
||||
|
||||
### Network Architecture Chain
|
||||
|
||||
```
|
||||
MASTER_INDEX.md
|
||||
└─> NETWORK_ARCHITECTURE.md (authoritative)
|
||||
├─> PHYSICAL_HARDWARE_INVENTORY.md
|
||||
├─> VMID_ALLOCATION_FINAL.md
|
||||
├─> DOMAIN_STRUCTURE.md
|
||||
├─> PROXMOX_CLUSTER_ARCHITECTURE.md
|
||||
└─> ER605_ROUTER_CONFIGURATION.md
|
||||
└─> CONFIGURATION_DECISION_TREE.md
|
||||
```
|
||||
|
||||
### Deployment Chain
|
||||
|
||||
```
|
||||
ORCHESTRATION_DEPLOYMENT_GUIDE.md
|
||||
├─> NETWORK_ARCHITECTURE.md
|
||||
├─> DEPLOYMENT_READINESS.md
|
||||
│ └─> CONFIGURATION_DECISION_TREE.md
|
||||
└─> OPERATIONAL_RUNBOOKS.md
|
||||
```
|
||||
|
||||
### Cloudflare Routing Chain
|
||||
|
||||
```
|
||||
CLOUDFLARE_ROUTING_MASTER.md (authoritative)
|
||||
├─> CLOUDFLARE_TUNNEL_ROUTING_ARCHITECTURE.md
|
||||
├─> CENTRAL_NGINX_ROUTING_SETUP.md
|
||||
└─> CLOUDFLARE_ZERO_TRUST_GUIDE.md
|
||||
```
|
||||
|
||||
### Troubleshooting Chain
|
||||
|
||||
```
|
||||
TROUBLESHOOTING_DECISION_TREE.md
|
||||
├─> TROUBLESHOOTING_FAQ.md
|
||||
├─> NETWORK_ARCHITECTURE.md
|
||||
└─> CHAIN138_BESU_CONFIGURATION.md
|
||||
```
|
||||
|
||||
### Quick Reference Chain
|
||||
|
||||
```
|
||||
Quick Reference Cards
|
||||
├─> NETWORK_QUICK_REFERENCE.md → NETWORK_ARCHITECTURE.md
|
||||
├─> VMID_QUICK_REFERENCE.md → VMID_ALLOCATION_FINAL.md
|
||||
├─> COMMANDS_QUICK_REFERENCE.md → OPERATIONAL_RUNBOOKS.md
|
||||
└─> TROUBLESHOOTING_QUICK_REFERENCE.md → TROUBLESHOOTING_FAQ.md
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Navigation Paths
|
||||
|
||||
### By Workflow
|
||||
|
||||
**Deployment Workflow:**
|
||||
1. README_START_HERE.md
|
||||
2. PREREQUISITES.md
|
||||
3. DEPLOYMENT_READINESS.md
|
||||
4. ORCHESTRATION_DEPLOYMENT_GUIDE.md
|
||||
5. NETWORK_ARCHITECTURE.md
|
||||
6. OPERATIONAL_RUNBOOKS.md
|
||||
|
||||
**Configuration Workflow:**
|
||||
1. CONFIGURATION_DECISION_TREE.md
|
||||
2. Select appropriate template
|
||||
3. Apply configuration
|
||||
4. Verify configuration
|
||||
|
||||
**Troubleshooting Workflow:**
|
||||
1. TROUBLESHOOTING_DECISION_TREE.md
|
||||
2. TROUBLESHOOTING_FAQ.md
|
||||
3. Specific troubleshooting guide
|
||||
4. Related documentation
|
||||
|
||||
---
|
||||
|
||||
## Document Categories
|
||||
|
||||
### Authoritative Documents (Single Source of Truth)
|
||||
|
||||
- **NETWORK_ARCHITECTURE.md** - Network architecture reference
|
||||
- **VMID_ALLOCATION_FINAL.md** - VMID allocation registry
|
||||
- **PHYSICAL_HARDWARE_INVENTORY.md** - Hardware inventory
|
||||
- **CLOUDFLARE_ROUTING_MASTER.md** - Cloudflare routing reference
|
||||
|
||||
### Reference Documents
|
||||
|
||||
- **MASTER_INDEX.md** - Complete documentation index
|
||||
- **GLOSSARY.md** - Terms and definitions
|
||||
- Quick reference cards - Quick lookup tables
|
||||
|
||||
### Guide Documents
|
||||
|
||||
- **ORCHESTRATION_DEPLOYMENT_GUIDE.md** - Deployment procedures
|
||||
- **OPERATIONAL_RUNBOOKS.md** - Operational procedures
|
||||
- **TROUBLESHOOTING_FAQ.md** - Troubleshooting guide
|
||||
|
||||
---
|
||||
|
||||
## Related Documentation
|
||||
|
||||
- **[MASTER_INDEX.md](MASTER_INDEX.md)** ⭐⭐⭐ - Complete documentation index
|
||||
- **[DOCUMENTATION_STYLE_GUIDE.md](DOCUMENTATION_STYLE_GUIDE.md)** ⭐⭐⭐ - Documentation standards
|
||||
- **[README.md](README.md)** ⭐⭐ - Documentation overview
|
||||
|
||||
---
|
||||
|
||||
**Last Updated:** 2025-01-20
|
||||
**Review Cycle:** Quarterly
|
||||
Reference in New Issue
Block a user