-
Notifications
You must be signed in to change notification settings - Fork 439
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: Add a DEBUG.md #7859
docs: Add a DEBUG.md #7859
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We have 196 components, so there should be 196 (+1 for the root README.md
, and +3 for the ones in dev
) files changed based on the READMEs alone.
Oh! Not all the README are the same! Let me update this. |
3137a8b
to
add4f48
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Mostly nits with the main problem being that DEBUG.md
does not show what the logging output looks like. We need to provide some example output so customers can know at a glance if the logging we provide will accomplish their needs.
DEBUG.md
Outdated
"chunked" | ||
] | ||
}, | ||
"response.payload": "{\n \"translations\": [\n {\n \"translatedText\": \"Hello\",\n \"detectedLanguageCode\": \"ja\"\n }\n ]\n}\n", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
more related to the actual logging code than to this PR, but we probably don't want to log whitespace (e.g. the newlines and spaces) in the response.payload.
Add documentation and instructions on how to use the debugging tools.