apache/openwhisk

documentation for how to debug

Open

#2262 opened on May 18, 2017

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

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

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.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic understanding of Apache OpenWhiskfamiliarity with debugging techniques
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Create a new file Debugging.md in the top level documentation directory. Research existing blog posts and community discussions about debugging OpenWhisk. Consolidate tips into a structured guide. Consider linking to relevant source code files for debugging APIs or logs.