Skip to content
This repository was archived by the owner on Oct 10, 2025. It is now read-only.

Commit d324d3d

Browse files
committed
docs: eliminate redundant DNS guide and consolidate documentation
- Remove docs/guides/providers/hetzner/hetzner-dns-setup-guide.md (650 lines) - Update all references to point to deployment-guide.md Part 3: DNS Configuration - Complete documentation consolidation following user preference for elimination over backward compatibility - Files updated: * hetzner-cloud-setup-guide.md: redirect DNS references to consolidated guide * guides/README.md: remove DNS guide from file tree structure * providers/README.md: remove DNS guide from provider structure * hetzner/README.md: replace DNS guide reference with deployment guide link * refactoring/hetzner-token-simplification.md: update documentation inventory This completes Phase 1 documentation consolidation. All DNS configuration is now covered comprehensively in the deployment guide Part 3, eliminating duplication while maintaining complete functionality. Ready for Phase 2: Create new Hetzner API tokens and test them.
1 parent 506f597 commit d324d3d

File tree

12 files changed

+1793
-1665
lines changed

12 files changed

+1793
-1665
lines changed

.github/copilot-instructions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -239,7 +239,7 @@ Comprehensive deployment, configuration, and testing guides are available in `do
239239

240240
| Guide | Purpose | Time | Use Case |
241241
| -------------------------------------------------------------------------- | ------------------------------- | ------ | ------------------- |
242-
| [Cloud Deployment Guide](../docs/guides/cloud-deployment-guide.md) | General cloud deployment | 30 min | First deployment |
242+
| [Deployment Guide](../docs/guides/deployment-guide.md) | Complete deployment guide | 30 min | First deployment |
243243
| [Integration Testing Guide](../docs/guides/integration-testing-guide.md) | Complete infrastructure testing | 15 min | Development |
244244
| [Smoke Testing Guide](../docs/guides/smoke-testing-guide.md) | Quick functionality validation | 5 min | Post-deployment |
245245
| [DNS Setup for Testing](../docs/guides/dns-setup-for-testing.md) | DNS configuration | 10 min | Domain setup |

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ peer connections, and system health.
150150

151151
## 🚀 Quick Start
152152

153-
**New users start here**: [**Deployment Guide**](docs/guides/cloud-deployment-guide.md) -
153+
**New users start here**: [**Deployment Guide**](docs/guides/deployment-guide.md) -
154154
Complete guide for deploying Torrust Tracker locally or in the cloud
155155

156156
For detailed setup instructions, see the specific documentation:
@@ -211,7 +211,7 @@ make dev-deploy ENVIRONMENT=local # Does all steps 3-4
211211

212212
### General Documentation
213213

214-
- [Deployment Guide](docs/guides/cloud-deployment-guide.md) - **Main deployment
214+
- [Deployment Guide](docs/guides/deployment-guide.md) - **Main deployment
215215
guide** for local development and planned cloud deployment
216216
- [Documentation Structure](docs/README.md) - Cross-cutting documentation
217217
- [Architecture Decisions](docs/adr/) - Design decisions and rationale

docs/README.md

Lines changed: 7 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -43,23 +43,13 @@ documentation that affects the project as a whole or provides reference material
4343
- [SSH Host Key Verification](infrastructure/ssh-host-key-verification.md) -
4444
Explains and resolves SSH host key verification warnings in VM development
4545

46-
### 📚 [`guides/`](guides/) (User and Developer Guides)
47-
48-
**High-level guides and end-to-end workflows** - For complete procedures
49-
that span multiple components.
50-
51-
**Current Guides:**
52-
53-
- [Integration Testing Guide](guides/integration-testing-guide.md) - Step-by-step
54-
guide for running integration tests following twelve-factor methodology
55-
- [Infrastructure Quick Start Guide](../infrastructure/docs/quick-start.md) - Fast
56-
setup guide for getting started quickly with local development
57-
- [Cloud Deployment Guide](guides/cloud-deployment-guide.md) - Complete deployment
58-
guide for local development and planned cloud deployment
59-
- [Grafana Setup Guide](guides/grafana-setup-guide.md) - Manual setup and
60-
configuration of Grafana monitoring dashboards
61-
- [Smoke Testing Guide](guides/smoke-testing-guide.md) - End-to-end testing
62-
using official Torrust client tools
46+
### User Guides
47+
48+
Deployment, configuration, and testing guides for various scenarios:
49+
50+
- [Deployment Guide](guides/deployment-guide.md) - Complete deployment
51+
guide for local and cloud environments
52+
- [Integration Testing Guide](guides/integration-testing-guide.md) -
6353

6454
### 🔧 [`refactoring/`](refactoring/) (Refactoring Documentation)
6555

docs/guides/README.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,10 @@ guides/
1010
├── README.md # This file - guides overview
1111
├── providers/ # Provider-specific deployment guides
1212
│ ├── README.md # Providers overview
13-
│ └── hetzner/ # Hetzner Cloud + DNS guides
13+
│ └── hetzner/ # Hetzner Cloud guides
1414
│ ├── README.md # Hetzner integration overview
15-
│ ├── hetzner-cloud-setup-guide.md # Hetzner Cloud server setup
16-
│ └── hetzner-dns-setup-guide.md # Hetzner DNS configuration
17-
├── cloud-deployment-guide.md # General cloud deployment guide
15+
│ └── hetzner-cloud-setup-guide.md # Hetzner Cloud server setup
16+
├── deployment-guide.md # Complete deployment guide (consolidated)
1817
├── dns-setup-for-testing.md # DNS configuration for testing
1918
├── grafana-setup-guide.md # Grafana monitoring setup
2019
├── grafana-subdomain-setup.md # Grafana subdomain configuration
@@ -28,11 +27,11 @@ guides/
2827

2928
### 🚀 Getting Started
3029

31-
| Guide | Description | Time | Use Case |
32-
| --------------------------------------------------------- | ------------------------ | ------ | ---------------- |
33-
| [Cloud Deployment Guide](cloud-deployment-guide.md) | General cloud deployment | 30 min | First deployment |
34-
| [Integration Testing Guide](integration-testing-guide.md) | Complete testing setup | 15 min | Development |
35-
| [Smoke Testing Guide](smoke-testing-guide.md) | Quick validation | 5 min | Post-deployment |
30+
| Guide | Description | Time | Use Case |
31+
| --------------------------------------------------------- | ------------------------- | ------ | ---------------- |
32+
| [Deployment Guide](deployment-guide.md) | Complete deployment guide | 30 min | First deployment |
33+
| [Integration Testing Guide](integration-testing-guide.md) | Complete testing setup | 15 min | Development |
34+
| [Smoke Testing Guide](smoke-testing-guide.md) | Quick validation | 5 min | Post-deployment |
3635

3736
### ☁️ Cloud Providers
3837

@@ -91,7 +90,7 @@ guides/
9190

9291
### For New Users
9392

94-
1. **Start Here**: [Cloud Deployment Guide](cloud-deployment-guide.md)
93+
1. **Start Here**: [Deployment Guide](deployment-guide.md)
9594
2. **Choose Provider**: [Providers Directory](providers/)
9695
3. **Validate**: [Smoke Testing Guide](smoke-testing-guide.md)
9796
4. **Monitor**: [Grafana Setup Guide](grafana-setup-guide.md)

0 commit comments

Comments
 (0)