feat(docs): add make troubleshoot target#42
Open
Aditi-24-05 wants to merge 1 commit into
Open
Conversation
There was a problem hiding this comment.
Thanks for your first PR to Pace — welcome aboard.
Quick orientation:
- CI runs in ~2 minutes. If anything fails, check the Actions tab — most failures have a one-line fix in
docs/troubleshooting.md. - If your PR touches
python/,ansible/, orterraform/, you'll be asked for a Test Report. It's worth the effort — reviewers rely on it. - Make sure the NetApp CCLA is on file before review.
- Stuck? Comment on this PR and a maintainer will jump in. We aim to respond as soon as possible.
For background, see CONTRIBUTING.md.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a
make troubleshoottarget to the Makefile as requested in #38.Running
make troubleshootprints a numbered, terminal-friendly index of all sections fromdocs/troubleshooting.md, each followed by a one-line tip extracted from the first###sub-heading under that section.Changes
Makefile: new.PHONY: troubleshoottarget under a# ---Docs ----sectionCONTRIBUTING.md: addedmake troubleshootrow to the Running checks locally tableOutput
Testing
make troubleshootexits 0make helplists the new target with its descriptionNotes
No ONTAP concepts touched. No new dependencies introduced.