Skip to content

Commit dc98108

Browse files
committed
refactor: [#232] Reorganize external tool issues under new external-issues folder
Consolidates external tool issue documentation into a unified structure for better organization and discoverability. Changes: - Created new docs/external-issues/ directory as parent folder - Moved docs/github-actions-issues/ → docs/external-issues/github-actions/ - Moved docs/tracker-issues/ → docs/external-issues/tracker/ - Created docs/external-issues/README.md with overview and scope guidelines - Updated all relative path references in moved documentation - Updated docs/README.md to reflect new structure - Updated AGENTS.md navigation table - Updated quick navigation: "Fix a CI issue" → "Fix external tool issues" Benefits: - Clearer separation between internal and external issues - Easier to add new external tool issue categories - Consistent naming (external-issues instead of mixed naming) - Better navigation and discoverability Related to #232 (documentation organization during MySQL implementation)
1 parent 363a70a commit dc98108

File tree

8 files changed

+78
-11
lines changed

8 files changed

+78
-11
lines changed

AGENTS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -220,7 +220,7 @@ The project has comprehensive documentation organized in the [`docs/`](docs/) di
220220
| Write unit tests | [`docs/contributing/testing/unit-testing.md`](docs/contributing/testing/unit-testing.md) |
221221
| Understand a decision | [`docs/decisions/README.md`](docs/decisions/README.md) |
222222
| Plan a new feature | [`docs/features/README.md`](docs/features/README.md) |
223-
| Fix a CI issue | [`docs/github-actions-issues/README.md`](docs/github-actions-issues/README.md) |
223+
| Fix external tool issues | [`docs/external-issues/README.md`](docs/external-issues/README.md) |
224224
| Work with templates | [`docs/contributing/templates.md`](docs/contributing/templates.md) |
225225
| Handle errors properly | [`docs/contributing/error-handling.md`](docs/contributing/error-handling.md) |
226226
| Handle output properly | [`docs/contributing/output-handling.md`](docs/contributing/output-handling.md) |

docs/README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ docs/
3636
├── refactors/ 🔄 Refactoring plans and tracking
3737
├── implementation-plans/ 📝 Step-by-step plans for complex changes
3838
├── issues/ 📋 Issue templates and specifications
39-
├── github-actions-issues/ ⚠️ CI/CD troubleshooting
39+
├── external-issues/ ⚠️ External tool issues (GitHub Actions, Tracker)
4040
└── analysis/ 📊 Code analysis (presentation layer structure)
4141
```
4242

@@ -82,7 +82,7 @@ docs/
8282
| Write unit tests | [`contributing/testing/unit-testing.md`](contributing/testing/unit-testing.md) |
8383
| Understand a decision | [`decisions/README.md`](decisions/README.md) |
8484
| Plan a new feature | [`features/README.md`](features/README.md) |
85-
| Fix a CI issue | [`github-actions-issues/README.md`](github-actions-issues/README.md) |
85+
| Fix external tool issues | [`external-issues/README.md`](external-issues/README.md) |
8686
| Work with templates | [`contributing/templates.md`](contributing/templates.md) |
8787
| Handle errors properly | [`contributing/error-handling.md`](contributing/error-handling.md) |
8888
| Handle output properly | [`contributing/output-handling.md`](contributing/output-handling.md) |
@@ -246,9 +246,11 @@ Ansible testing strategy, Docker vs LXD, E2E testing, UX patterns, MVVM analysis
246246

247247
- [`issues/`](issues/) - Templates for epics, issues, and specifications
248248

249-
**CI/CD Troubleshooting:**
249+
**External Tool Issues:**
250250

251-
- [`github-actions-issues/README.md`](github-actions-issues/README.md) - GitHub Actions runner issues
251+
- [`external-issues/README.md`](external-issues/README.md) - Issues with external tools (GitHub Actions, Tracker)
252+
- [`external-issues/github-actions/`](external-issues/github-actions/) - GitHub Actions CI/CD issues
253+
- [`external-issues/tracker/`](external-issues/tracker/) - Torrust Tracker issues
252254

253255
**Code Analysis:**
254256

docs/external-issues/README.md

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# External Issues Documentation
2+
3+
This directory contains documentation about issues found in **external tools and services** during development and testing of the Torrust Tracker Deployer, not issues with the deployer application itself.
4+
5+
## Purpose
6+
7+
When developing and testing the deployer, we sometimes discover issues, limitations, or unexpected behaviors in external tools and services we depend on. This folder documents those findings for reference, workarounds, and potential upstream fixes.
8+
9+
## Subdirectories
10+
11+
### [`github-actions/`](github-actions/)
12+
13+
Issues related to GitHub Actions CI/CD environment:
14+
15+
- Runner limitations
16+
- Network connectivity issues
17+
- Resource constraints
18+
- CI-specific environment problems
19+
20+
### [`tracker/`](tracker/)
21+
22+
Issues related to the Torrust Tracker application and container:
23+
24+
- Tracker container behavior issues
25+
- Tracker configuration problems
26+
- Tracker entrypoint script issues
27+
- Tracker application bugs discovered during deployment
28+
- Tracker API inconsistencies
29+
- Tracker database driver issues
30+
31+
## Scope
32+
33+
**IN SCOPE** (belongs here):
34+
35+
- External tool bugs or limitations
36+
- Third-party service issues
37+
- Dependency behavior that affects the deployer
38+
- Upstream issues requiring workarounds
39+
- External API inconsistencies
40+
41+
**OUT OF SCOPE** (belongs elsewhere):
42+
43+
- Deployer bugs → GitHub Issues in this repository
44+
- Infrastructure code issues → Code fixes in `src/`
45+
- Template rendering problems → Code fixes in `src/infrastructure/templating/`
46+
- Ansible playbook issues → Code fixes in `templates/ansible/`
47+
- Development workflow issues → `docs/contributing/known-issues.md`
48+
49+
## Document Format
50+
51+
Each issue should be documented with:
52+
53+
1. **Problem Description**: Clear explanation of the issue
54+
2. **Root Cause**: Analysis of why it happens
55+
3. **Impact**: How it affects the deployer
56+
4. **Current Workaround**: How we handle it in the deployer
57+
5. **Recommended Solution**: Proposed fix for the upstream project
58+
6. **References**: Links to relevant external documentation or issues
59+
60+
## Related Documentation
61+
62+
- [Contributing Guidelines](../contributing/README.md)
63+
- [Known Issues](../contributing/known-issues.md) (deployer-specific issues)
64+
- [Documentation Index](../README.md)
File renamed without changes.

docs/github-actions-issues/docker-apt-cache-issue.md renamed to docs/external-issues/github-actions/docker-apt-cache-issue.md

File renamed without changes.
File renamed without changes.
Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ When testing the deployer, we sometimes discover issues, limitations, or unexpec
2020
**OUT OF SCOPE** (belongs elsewhere):
2121

2222
- Deployer bugs → GitHub Issues in this repository
23-
- Infrastructure provisioning issues → `docs/github-actions-issues/` or `docs/contributing/known-issues.md`
23+
- Infrastructure provisioning issues → `docs/external-issues/github-actions/` or `docs/contributing/known-issues.md`
2424
- Template rendering problems → Code fixes in `src/infrastructure/templating/`
2525
- Ansible playbook issues → Code fixes in `templates/ansible/`
2626

@@ -43,4 +43,5 @@ Each issue should be documented with:
4343

4444
- [Torrust Tracker Repository](https://github.com/torrust/torrust-tracker)
4545
- [Torrust Tracker Container Images](https://hub.docker.com/r/torrust/tracker)
46-
- [Contributing Guidelines](../contributing/README.md)
46+
- [External Issues Overview](../README.md)
47+
- [Contributing Guidelines](../../contributing/README.md)

docs/tracker-issues/database-driver-double-specification.md renamed to docs/external-issues/tracker/database-driver-double-specification.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -200,7 +200,7 @@ fi
200200
- **Tracker Entrypoint**: <https://github.com/torrust/torrust-tracker/blob/develop/share/container/entry_script_sh>
201201
- **Demo Compose**: <https://github.com/torrust/torrust-demo/blob/main/compose.yaml>
202202
- **Configuration Override Pattern**: Uses `TORRUST_TRACKER_CONFIG_OVERRIDE_*` prefix for environment variable overrides
203-
- **Related**: Environment variable naming decision - [`docs/decisions/environment-variable-prefix.md`](../decisions/environment-variable-prefix.md)
203+
- **Related**: Environment variable naming decision - [`docs/decisions/environment-variable-prefix.md`](../../decisions/environment-variable-prefix.md)
204204

205205
## Action Items
206206

@@ -212,6 +212,6 @@ fi
212212

213213
## Related Documentation
214214

215-
- **Our Environment Variable Injection**: [`docs/decisions/environment-variable-injection-in-docker-compose.md`](../decisions/environment-variable-injection-in-docker-compose.md)
216-
- **Template System**: [`docs/technical/template-system-architecture.md`](../technical/template-system-architecture.md)
217-
- **Output Handling**: [`docs/contributing/output-handling.md`](../contributing/output-handling.md)
215+
- **Our Environment Variable Injection**: [`docs/decisions/environment-variable-injection-in-docker-compose.md`](../../decisions/environment-variable-injection-in-docker-compose.md)
216+
- **Template System**: [`docs/technical/template-system-architecture.md`](../../technical/template-system-architecture.md)
217+
- **Output Handling**: [`docs/contributing/output-handling.md`](../../contributing/output-handling.md)

0 commit comments

Comments
 (0)