Skip to content

Commit 383a452

Browse files
committed
docs: add comprehensive user guide and update documentation links
- Create main user guide entry point (docs/user-guide/README.md) with: - Quick start guide with step-by-step instructions - Available commands reference - Configuration guide with all options - Common troubleshooting scenarios - Links to all related documentation - Update main README.md: - Add prominent link to user guide in Usage section - Clarify that manual provisioning via E2E tests is temporary workaround - Add user guide link to Documentation section - Update .github/copilot-instructions.md: - Add docs/user-guide/ to Key Directories for AI assistant discovery The user guide provides comprehensive documentation for end users covering the create, destroy, and template generation commands currently available in production. Future commands (deploy, run, status) are documented as coming soon.
1 parent ec1d4cd commit 383a452

3 files changed

Lines changed: 440 additions & 3 deletions

File tree

.github/copilot-instructions.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ This is a deployment infrastructure proof-of-concept for the Torrust ecosystem.
2525
- `templates/` - Generated template examples and test fixtures
2626
- `build/` - Generated runtime configurations (git-ignored)
2727
- `docs/` - Project documentation
28+
- `docs/user-guide/` - User-facing documentation (getting started, commands, configuration)
2829
- `docs/decisions/` - Architectural Decision Records (ADRs)
2930
- `scripts/` - Shell scripts for development tasks
3031
- `fixtures/` - Test data and keys for development

README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -107,6 +107,8 @@ cargo install --path .
107107
torrust-tracker-deployer
108108
```
109109

110+
For detailed usage instructions, command reference, and examples, see the **[👤 User Guide](docs/user-guide/README.md)**.
111+
110112
The application includes comprehensive logging with configurable format, output mode, and directory. See **[📖 Logging Guide](docs/user-guide/logging.md)** for details on logging configuration options.
111113

112114
#### 🔧 Development Tasks
@@ -166,6 +168,8 @@ cargo run --bin e2e-tests-full -- --help
166168

167169
> **⚠️ Manual deployment is not currently possible.** The application only supports E2E tests with hardcoded environments.
168170
>
171+
> **Temporary Workaround:** Until the `provision` command is available as a user-facing command, you can use E2E tests to provision infrastructure for experimentation. See the reference section below for details.
172+
>
169173
> **To explore the deployment process:**
170174
>
171175
> 1. Run E2E tests with `--keep` flag: `cargo run --bin e2e-tests-full -- --keep`
@@ -175,7 +179,9 @@ cargo run --bin e2e-tests-full -- --help
175179
> **Manual deployment commands will be available after completing the [roadmap](docs/roadmap.md).**
176180
177181
<details>
178-
<summary>📋 <strong>Reference: Experimenting with OpenTofu and Ansible manually</strong></summary>
182+
<summary>📋 <strong>Reference: Experimenting with OpenTofu and Ansible manually (Temporary Workaround)</strong></summary>
183+
184+
> **Note:** This is a **temporary workaround** for experimentation until the `provision` command is available as a user-facing CLI command. Currently, infrastructure provisioning is only implemented in E2E tests.
179185
180186
If you want to experiment with OpenTofu and Ansible commands directly using the generated templates:
181187

@@ -372,9 +378,10 @@ This project follows a structured development roadmap to evolve from the current
372378

373379
## 📚 Documentation
374380

381+
- **[👤 User Guide](docs/user-guide/README.md)** - Getting started, command reference, and usage examples
375382
- **[🤝 Contributing Guide](docs/contributing/README.md)** - Git workflow, commit process, and linting conventions
376-
- **[ Roadmap](docs/roadmap.md)** - Development roadmap and MVP goals
377-
- **[📖 Documentation Organization Guide](docs/documentation.md)** - How documentation is organized and where to contribute
383+
- **[🗺️ Roadmap](docs/roadmap.md)** - Development roadmap and MVP goals
384+
- **[📖 Documentation Organization Guide](docs/documentation.md)** - How documentation is organized and where to contribute
378385
- **[📖 OpenTofu Setup Guide](docs/tech-stack/opentofu.md)** - Installation, common commands, and best practices
379386
- **[📖 Ansible Setup Guide](docs/tech-stack/ansible.md)** - Installation, configuration, and project usage
380387
- **[📖 VM Providers Comparison](docs/vm-providers.md)** - Detailed comparison and decision rationale

0 commit comments

Comments
 (0)