Skip to content

Commit e29b300

Browse files
committed
docs: [#19] add GitHub issue links to epic and subissue documents
1 parent bba14dd commit e29b300

File tree

3 files changed

+21
-21
lines changed

3 files changed

+21
-21
lines changed

docs/issues/19.1-create-variables-template.md renamed to docs/issues/105-create-variables-template.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Create Variables Template
22

3-
**Issue**: #19.1
4-
**Parent Epic**: #19 - Refactor Ansible Templates to Variables Pattern
3+
**Issue**: [#105](https://github.com/torrust/torrust-tracker-deployer/issues/105)
4+
**Parent Epic**: [#19](https://github.com/torrust/torrust-tracker-deployer/issues/19) - Refactor Ansible Templates to Variables Pattern
55
**Related**: [Parent Epic](./19-refactor-ansible-templates-variables-pattern.md), [Template System Architecture](../technical/template-system-architecture.md)
66

77
## Overview

docs/issues/19.2-convert-firewall-template-to-static.md renamed to docs/issues/106-convert-firewall-template-to-static.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# Convert Firewall Template to Static
22

3-
**Issue**: #19.2
4-
**Parent Epic**: #19 - Refactor Ansible Templates to Variables Pattern
5-
**Depends On**: #19.1 - Create Variables Template
6-
**Related**: [Parent Epic](./19-refactor-ansible-templates-variables-pattern.md), [Issue #19.1](./19.1-create-variables-template.md)
3+
**Issue**: [#106](https://github.com/torrust/torrust-tracker-deployer/issues/106)
4+
**Parent Epic**: [#19](https://github.com/torrust/torrust-tracker-deployer/issues/19) - Refactor Ansible Templates to Variables Pattern
5+
**Depends On**: [#105](https://github.com/torrust/torrust-tracker-deployer/issues/105) - Create Variables Template
6+
**Related**: [Parent Epic](./19-refactor-ansible-templates-variables-pattern.md), [Issue #105](./105-create-variables-template.md)
77

88
## Overview
99

docs/issues/19-refactor-ansible-templates-variables-pattern.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# EPIC: Refactor Ansible Templates to Variables Pattern
22

3-
**Issue**: #19
3+
**Issue**: [#19](https://github.com/torrust/torrust-tracker-deployer/issues/19)
44
**Type**: EPIC
55
**Parent Epic**: #16 - Finish ConfigureCommand - System Security Configuration
66
**Depends On**: #18 - Configure UFW Firewall
@@ -16,8 +16,8 @@ After implementing the security updates and firewall configuration, we now have
1616

1717
This EPIC uses **vertical slice** approach - each sub-task is a complete, independently deployable increment:
1818

19-
- [ ] #19.1 - [Create Variables Template Infrastructure](./19.1-create-variables-template.md) - Complete implementation with unit tests and documentation
20-
- [ ] #19.2 - [Convert Firewall to Variables Pattern](./19.2-convert-firewall-template-to-static.md) - Complete conversion including cleanup, documentation updates, and full validation
19+
- [ ] [#105](https://github.com/torrust/torrust-tracker-deployer/issues/105) - [Create Variables Template Infrastructure](./105-create-variables-template.md) - Complete implementation with unit tests and documentation
20+
- [ ] [#106](https://github.com/torrust/torrust-tracker-deployer/issues/106) - [Convert Firewall to Variables Pattern](./106-convert-firewall-template-to-static.md) - Complete conversion including cleanup, documentation updates, and full validation
2121

2222
## Goals
2323

@@ -115,7 +115,7 @@ This epic uses **vertical slice methodology** - each sub-task is a complete, ind
115115

116116
**Outcome**: System works with new variables infrastructure in place, fully tested and documented.
117117

118-
**See**: [19.1-create-variables-template.md](./19.1-create-variables-template.md)
118+
**See**: [Issue #105](./105-create-variables-template.md)
119119

120120
### Vertical Slice 2: Convert Firewall to Variables Pattern (Estimated: 4.5 days)
121121

@@ -137,7 +137,7 @@ This epic uses **vertical slice methodology** - each sub-task is a complete, ind
137137

138138
**Outcome**: System works with firewall using variables pattern, old code removed, documentation updated, all tests passing.
139139

140-
**See**: [19.2-convert-firewall-template-to-static.md](./19.2-convert-firewall-template-to-static.md)
140+
**See**: [Issue #106](./106-convert-firewall-template-to-static.md)
141141

142142
### Total Estimated Time
143143

@@ -161,7 +161,7 @@ This epic uses **vertical slice methodology** - each sub-task is a complete, ind
161161

162162
### Dependencies
163163

164-
- #19.2 requires #19.1 to be completed (variables template must exist)
164+
- #106 requires #105 to be completed (variables template must exist)
165165

166166
## High-Level Architecture Changes
167167

@@ -309,7 +309,7 @@ All implementation details have been moved to the following sub-task documents:
309309

310310
### Task 1: Create Variables Template Infrastructure
311311

312-
See **[Issue #19.1 - Create Variables Template](./19.1-create-variables-template.md)** for complete implementation details including:
312+
See **[Issue #105 - Create Variables Template](./105-create-variables-template.md)** for complete implementation details including:
313313

314314
- Template file structure (`variables.yml.tera`)
315315
- Context implementation (`AnsibleVariablesContext`)
@@ -320,7 +320,7 @@ See **[Issue #19.1 - Create Variables Template](./19.1-create-variables-template
320320

321321
### Task 2: Convert Firewall Template to Static (Complete Vertical Slice)
322322

323-
See **[Issue #19.2 - Convert Firewall Template to Static](./19.2-convert-firewall-template-to-static.md)** for complete implementation details including:
323+
See **[Issue #106 - Convert Firewall Template to Static](./106-convert-firewall-template-to-static.md)** for complete implementation details including:
324324

325325
- Template conversion (remove `.tera`, add `vars_files`)
326326
- Static file registration in `copy_static_templates()`
@@ -335,8 +335,8 @@ See **[Issue #19.2 - Convert Firewall Template to Static](./19.2-convert-firewal
335335

336336
Refer to individual sub-task acceptance criteria for detailed requirements:
337337

338-
- **Issue #19.1**: Variables template infrastructure created and tested
339-
- **Issue #19.2**: Firewall playbook converted to static with complete cleanup, documentation updates, and validation
338+
- **Issue #105**: Variables template infrastructure created and tested
339+
- **Issue #106**: Firewall playbook converted to static with complete cleanup, documentation updates, and validation
340340

341341
### High-Level Success Metrics
342342

@@ -361,7 +361,7 @@ For detailed implementation guidance, refer to the individual sub-task documents
361361

362362
## AI Agent Guidance
363363

364-
When implementing this EPIC, work through the sub-tasks in the specified order (#19.1#19.2). Each sub-task document contains:
364+
When implementing this EPIC, work through the sub-tasks in the specified order (#105#106). Each sub-task document contains:
365365

366366
- Detailed phase-by-phase implementation steps
367367
- "Baby steps" approach to keep tests green
@@ -373,7 +373,7 @@ When implementing this EPIC, work through the sub-tasks in the specified order (
373373
- ✅ Agent can run: `cargo test`, `cargo run --bin e2e-config-tests`, `cargo run --bin linter all`
374374
- ❌ Agent cannot run: `cargo run --bin e2e-tests-full` (requires LXD/VMs - human reviewer must execute)
375375

376-
**Note**: Task #19.2 is a complete vertical slice that includes implementation, cleanup of old code, documentation updates, and full validation all in one task.
376+
**Note**: Task #106 is a complete vertical slice that includes implementation, cleanup of old code, documentation updates, and full validation all in one task.
377377

378378
## Detailed Acceptance Criteria
379379

@@ -481,14 +481,14 @@ This refactoring is perfectly timed because:
481481
1. **Inventory Limitation**: Keep `inventory.yml.tera` as Tera template (Ansible inventories don't support `vars_files`)
482482
2. **Variables Scope**: Only system configuration variables in `variables.yml` (connection details stay in inventory)
483483
3. **AnsibleClient Generic**: Update signature to accept optional extra args for flexibility
484-
4. **Clean Up Old Code**: Delete `firewall_playbook` renderer and wrapper as part of #19.2 (vertical slice)
484+
4. **Clean Up Old Code**: Delete `firewall_playbook` renderer and wrapper as part of #106 (vertical slice)
485485

486486
### Implementation Order
487487

488488
Follow the subtasks in sequence:
489489

490-
1. **Task #19.1**: Create variables template infrastructure (new files, no breaking changes)
491-
2. **Task #19.2**: Convert firewall template to static - complete vertical slice including:
490+
1. **Task #105**: Create variables template infrastructure (new files, no breaking changes)
491+
2. **Task #106**: Convert firewall template to static - complete vertical slice including:
492492
- Template conversion and API updates
493493
- Cleanup of old architecture
494494
- Documentation updates

0 commit comments

Comments
 (0)