Skip to content

[good-first-issue] Add make troubleshoot target #38

@hvinn

Description

@hvinn

Estimated time

15-20 minutes

Exact files to change

  • Makefile (new .PHONY: troubleshoot target)
  • CONTRIBUTING.md (the Running checks locally table)

Expected outcome

make troubleshoot extracts the ## headings from
docs/troubleshooting.md and prints them as a numbered terminal-friendly
index, each followed by a one-line tip. make help still shows the new
target with its ## description.

How to test

make troubleshoot

Exits 0, prints at least 5 sections (Connection Errors, Authentication,
SSL/TLS, Pre-commit and CI, Docker), and stays under 30 lines of output.

make help

Lists the new target.

ONTAP concepts touched

None.

Hints / gotchas

A grep "^## " docs/troubleshooting.md plus awk or a nl pipe is enough.
Keep the Makefile body under 15 lines. Use awk -F'## ' '/^## /{print NR-1, $2}'
or similar for numbering. Do not forget the ## comment after the target name
so make help picks it up.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions