Skip to content

Commit 00cf064

Browse files
committed
docs: enhance README and workflow documentation with verbose mode usage
This commit adds a "Quick Start" section to the README.md, outlining essential task commands for development and deployment. It also expands the development workflow documentation to include detailed instructions on using verbose mode for debugging tasks. Additionally, the task reference document is updated to clarify task control options, including examples of using verbose and silent modes.
1 parent f9be059 commit 00cf064

File tree

3 files changed

+87
-0
lines changed

3 files changed

+87
-0
lines changed

applications/wg-easy/README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,30 @@ applications/wg-easy/
6868
└── Taskfile.yaml # Main task definitions
6969
```
7070

71+
## Quick Start
72+
73+
The pattern provides a complete workflow from development to deployment. Here are the essential commands:
74+
75+
```bash
76+
# List all available tasks
77+
task --list
78+
79+
# Create a test environment and deploy (verbose mode for detailed output)
80+
task -v full-test-cycle
81+
82+
# Individual development tasks
83+
task cluster-create # Create test cluster
84+
task -v helm-install # Deploy charts with detailed output
85+
task test # Run validation tests
86+
task cluster-delete # Clean up resources
87+
88+
# Release preparation
89+
task release-prepare # Package charts and merge configs
90+
task release-create # Create and promote release
91+
```
92+
93+
**Tip**: Use `task -v <taskname>` for detailed execution output during development and debugging.
94+
7195
## Architecture Overview
7296

7397
Key components:

applications/wg-easy/docs/development-workflow.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,20 @@ Before starting the development workflow, ensure you have the following tools in
2626

2727
All other tools will be automatically provided through task commands and containers.
2828

29+
### Debugging with Verbose Mode
30+
31+
All tasks run in silent mode by default. When debugging issues or understanding what's happening during development, use the verbose flag:
32+
33+
```bash
34+
# Show detailed execution for debugging
35+
task -v cluster-create
36+
task -v helm-install
37+
38+
# Standard silent output for production use
39+
task cluster-create
40+
task helm-install
41+
```
42+
2943
## Workflow Stages
3044

3145
### Stage 1: Chart Dependencies and Verification
@@ -135,6 +149,16 @@ Deploy individual charts to a test cluster to verify functionality.
135149
task setup-kubeconfig
136150
```
137151

152+
**Debugging cluster issues:**
153+
```bash
154+
# Use verbose mode to see detailed cluster creation process
155+
task -v cluster-create
156+
task -v setup-kubeconfig
157+
158+
# Check cluster status manually
159+
task cluster-list
160+
```
161+
138162
2. Run preflight checks on your chart:
139163

140164
```bash
@@ -143,6 +167,12 @@ Deploy individual charts to a test cluster to verify functionality.
143167
helm template ./charts/wg-easy | kubectl preflight - --dry-run
144168
```
145169

170+
**Debugging preflight issues:**
171+
```bash
172+
# See detailed preflight execution
173+
task -v helm-preflight
174+
```
175+
146176
3. Install a single chart:
147177

148178
```bash

applications/wg-easy/docs/task-reference.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,39 @@
22

33
This document provides a concise reference for the tasks available in the WG-Easy Helm chart development pattern, organized by their purpose in the development workflow.
44

5+
## Task Control Options
6+
7+
All tasks are configured to run in silent mode by default, showing only essential output. You can control the verbosity level using Task's built-in flags:
8+
9+
| Flag | Description | Example |
10+
|------|-------------|---------|
11+
| `--verbose` or `-v` | Show detailed task execution information including commands being run | `task -v cluster-create` |
12+
| `--silent` or `-s` | Suppress all output except errors | `task -s dependencies-update` |
13+
| (default) | Silent mode - shows command output but not task execution details | `task cluster-create` |
14+
15+
### Verbose Mode Examples
16+
17+
**Development and Debugging:**
18+
```bash
19+
# See detailed cluster creation process
20+
task -v cluster-create
21+
22+
# Debug helm installation issues
23+
task -v helm-install
24+
25+
# Watch full test cycle execution
26+
task -v full-test-cycle
27+
```
28+
29+
**Production Use:**
30+
```bash
31+
# Suppress all output for automation
32+
task -s release-prepare
33+
34+
# Standard output for CI/CD
35+
task release-create
36+
```
37+
538
## Development Tasks
639

740
These tasks support the iterative development process, focusing on fast feedback loops.

0 commit comments

Comments
 (0)