apache/openwhisk

documentation for how to debug

Open

#2,262 opened on May 18, 2017

View on GitHub
 (2 comments) (7 reactions) (0 assignees)Scala (1,177 forks)batch import
documentationhelp wantedtooling

Repository metrics

Stars
 (6,777 stars)
PR merge metrics
 (Avg merge 17h 31m) (3 merged PRs in 30d)

Description

I hear a lot that debugging is a big pain point.

Suggest we start a top-level section in the documentation called "Debugging.md", with tips and tricks for debugging. There are various blog posts and unofficial tools available -- I think it will be useful to have an easy-to-find, somewhat authoritative source of documentation on "How To Debug"

Contributor guide

Research direction
Compile debugging tips from existing blog posts and tools for the project. Start by reviewing the current documentation and identify common debugging scenarios.
Tech stack
None
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85