Skip to content
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

Merged
merged 8 commits into from
Dec 11, 2024
Merged

docs: Add a DEBUG.md #7859

merged 8 commits into from
Dec 11, 2024

Conversation

Hectorhammett
Copy link
Collaborator

Add documentation and instructions on how to use the debugging tools.

@Hectorhammett Hectorhammett requested review from a team as code owners November 26, 2024 22:25
@bshaffer bshaffer added the next release PRs to be included in the next release label Dec 3, 2024
Copy link
Contributor

@bshaffer bshaffer left a 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.

@Hectorhammett
Copy link
Collaborator Author

Oh! Not all the README are the same! Let me update this.

Copy link
Contributor

@bshaffer bshaffer left a 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 Show resolved Hide resolved
DEBUG.md Outdated Show resolved Hide resolved
DEBUG.md Outdated Show resolved Hide resolved
DEBUG.md Outdated Show resolved Hide resolved
DEBUG.md Outdated Show resolved Hide resolved
DEBUG.md Show resolved Hide resolved
DEBUG.md Outdated
"chunked"
]
},
"response.payload": "{\n \"translations\": [\n {\n \"translatedText\": \"Hello\",\n \"detectedLanguageCode\": \"ja\"\n }\n ]\n}\n",
Copy link
Contributor

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.

@bshaffer bshaffer enabled auto-merge (squash) December 11, 2024 19:48
@bshaffer bshaffer merged commit a37853f into main Dec 11, 2024
29 of 31 checks passed
@bshaffer bshaffer deleted the debug-md branch December 11, 2024 20:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
next release PRs to be included in the next release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants