nuts-foundation / nuts-foundation/nuts-node
Add debugging introduction to read the docs
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 28
- Forks
- 23
- Avg merge
- 1d 10h
- Merged PRs (30d)
- 76
Description
This should provide a starting point to start debugging any node issues (/status/diagnostics, /health, log level=info and up?). It is not a step-by-step guide to fix all problems.
This could optionally include a template of what to include when requesting help on slack. (And add bookmark to this on slack)
This can possibly be merged with https://nuts-node.readthedocs.io/en/stable/pages/integrating/faq-errors.html
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review the existing FAQ at pages/integrating/faq-errors.html and the Read the Docs structure before deciding whether to extend or merge it. Cover /status/diagnostics, /health, and relevant log levels as an introductory debugging starting point, with an optional Slack help-request template and bookmark; done means the guidance is published without becoming a complete troubleshooting guide.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100