sentry-docs icon indicating copy to clipboard operation
sentry-docs copied to clipboard

docs: document the log levels in a convenient place

Open johngallagher opened this issue 3 years ago • 3 comments

What

Put the log level options under the code telling us how to set the log level.

Why

So that I don't have to guess or search the docs for the level options and I can speedily implement my change.

How

Copy paste the log level from the JS docs.

Future suggestions

It'd be better to have one page with all the levels then each language can just reference that place.

Legal Boilerplate

Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.

johngallagher avatar Aug 09 '22 09:08 johngallagher

@johngallagher is attempting to deploy a commit to the Sentry Team on Vercel.

A member of the Team first needs to authorize it.

vercel[bot] avatar Aug 09 '22 09:08 vercel[bot]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated
sentry-docs ✅ Ready (Inspect) Visit Preview Aug 15, 2022 at 4:25PM (UTC)

vercel[bot] avatar Aug 15 '22 16:08 vercel[bot]

@johngallagher - Thanks for contributing!

This is a page that's common to almost all our SDKs, but the specific content for each SDK can be different. The logging levels information is included for JavaScript and Python, for example, where it's displayed right after the first code snippet on the page. But it's not shown for .NET. With the edit that you've added, that information would now show up twice for JavaScript at the top and bottom of the page: https://sentry-docs-git-fork-johngallagher-patch-2.sentry.dev/platforms/javascript/usage/set-level/

Is the issue the placement of the text or that you weren't able to find this information for a specific SDK? That would help with making a more precise edit.

imatwawana avatar Aug 15 '22 16:08 imatwawana

This pull request has gone three weeks without activity. In another week, I will close it.

But! If you comment or otherwise update it, I will reset the clock, and if you label it Status: Backlog or Status: In Progress, I will leave it alone ... forever!


"A weed is but an unloved flower." ― Ella Wheeler Wilcox 🥀

github-actions[bot] avatar Sep 06 '22 00:09 github-actions[bot]

@johngallagher - Please see my question above.

imatwawana avatar Sep 06 '22 14:09 imatwawana

@johngallagher - Thanks for contributing!

This is a page that's common to almost all our SDKs, but the specific content for each SDK can be different. The logging levels information is included for JavaScript and Python, for example, where it's displayed right after the first code snippet on the page. But it's not shown for .NET. With the edit that you've added, that information would now show up twice for JavaScript at the top and bottom of the page: https://sentry-docs-git-fork-johngallagher-patch-2.sentry.dev/platforms/javascript/usage/set-level/

Is the issue the placement of the text or that you weren't able to find this information for a specific SDK? That would help with making a more precise edit.

Sorry for the delay! Yup the issue was I couldn't find these levels in the Ruby docs...

johngallagher avatar Sep 06 '22 17:09 johngallagher

I've opened a new PR #5494 because we've changed our docs structure a bit since you opened this one. Please take a look at the preview on that PR and let me know if this edit addresses your concern: https://sentry-docs-git-fix-add-log-levels-for-ruby.sentry.dev/platforms/ruby/usage/set-level/

In the meantime, I'll go ahead and close this PR.

imatwawana avatar Sep 07 '22 20:09 imatwawana