Skip to content

feat(docs): add make troubleshoot target #42

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Aditi-24-05 wants to merge 1 commit into
base: main
Choose a base branch
from
+8 −0
Open

feat(docs): add make troubleshoot target #42

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -183,6 +183,7 @@ make ci # Run lint (mirrors ci.yml)
make lint # Ruff lint + format check
make ansible-lint # Ansible syntax-check + ansible-lint
make terraform-validate # Terraform fmt, validate, tflint
make troubleshoot # Print numbered troubleshooting index
```

Run `make ci` before pushing to catch issues before they hit CI.
Expand Down
7 changes: 7 additions & 0 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,3 +71,10 @@ hooks: ## Install pre-commit hooks into your local repo
help: ## Show this help
@grep -E '^[a-zA-Z_-]+:.*?## ' $(MAKEFILE_LIST) | \
awk 'BEGIN {FS = ":.*?## "}; {printf " \033[36m%-22s\033[0m %s\n", $$1, $$2}'

# ── Docs ───────────────────────────────────────────────────────
.PHONY: troubleshoot
troubleshoot: ## Show numbered index of troubleshooting sections
@echo "The Troubleshooting Guide"
@echo ""
@awk '/^## / { if (heading) printf "%2d. %s\n Tip: %s\n\n", ++count, heading, tip; heading=substr($$0,4); tip="" } /^### / && heading && !tip { tip=substr($$0,5) } END { if (heading) printf "%2d. %s\n Tip: %s\n\n", ++count, heading, tip }' docs/troubleshooting.md
Loading