Skip to content

feat(docs): add make troubleshoot target#42

Open
Aditi-24-05 wants to merge 1 commit into
NetApp:mainfrom
Aditi-24-05:feature/troubleshoot-target
Open

feat(docs): add make troubleshoot target#42
Aditi-24-05 wants to merge 1 commit into
NetApp:mainfrom
Aditi-24-05:feature/troubleshoot-target

Conversation

@Aditi-24-05
Copy link
Copy Markdown

Summary

Adds a make troubleshoot target to the Makefile as requested in #38.

Running make troubleshoot prints a numbered, terminal-friendly index of all sections from docs/troubleshooting.md, each followed by a one-line tip extracted from the first ### sub-heading under that section.

Changes

  • Makefile : new .PHONY: troubleshoot target under a # ---Docs ---- section
  • CONTRIBUTING.md : added make troubleshoot row to the Running checks locally table

Output

$ make troubleshoot
The Troubleshooting Guide 

 1. Connection Errors
    Tip: "Connection refused" or timeout when running a script

 2. Authentication Failures
    Tip: HTTP 401 - Unauthorized

 3. SSL / TLS Errors
    Tip: "SSL: CERTIFICATE_VERIFY_FAILED"

 4. Python Script Issues
    Tip: `ModuleNotFoundError: No module named 'ontap_client'`

 5. Ansible Issues
    Tip: `ERROR! the role 'netapp.ontap.*' was not found`

 6. Terraform Issues
    Tip: Provider initialization failure

 7. NFS Provisioning
    Tip: Volume already exists

 8. Pre-commit and CI
    Tip: TruffleHog false positive

 9. Docker
    Tip: Build fails on ARM / Apple Silicon

Testing

  • make troubleshoot exits 0
  • Prints all 9 sections with tips
  • Output is under 30 lines
  • make help lists the new target with its description

Notes

No ONTAP concepts touched. No new dependencies introduced.

Copy link
Copy Markdown

@github-actions github-actions Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your first PR to Pace — welcome aboard.

Quick orientation:

  1. CI runs in ~2 minutes. If anything fails, check the Actions tab — most failures have a one-line fix in docs/troubleshooting.md.
  2. If your PR touches python/, ansible/, or terraform/, you'll be asked for a Test Report. It's worth the effort — reviewers rely on it.
  3. Make sure the NetApp CCLA is on file before review.
  4. Stuck? Comment on this PR and a maintainer will jump in. We aim to respond as soon as possible.

For background, see CONTRIBUTING.md.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants