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

Add sentry-graphql docs. #4385

Merged
merged 9 commits into from
Nov 19, 2021
Merged

Conversation

maciejwalkowiak
Copy link
Contributor

@vercel
Copy link

vercel bot commented Nov 12, 2021

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/sentry/sentry-docs/3Z5Rv23d5nSpxiW1Btv4tCThK2sD
✅ Preview: https://sentry-docs-git-fork-maciejwalkowiak-java-gh-v.sentry.dev

Copy link
Contributor

@marandaneto marandaneto left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

left comments

src/platforms/java/common/graphql.mdx Outdated Show resolved Hide resolved
src/platforms/java/common/graphql.mdx Outdated Show resolved Hide resolved
Copy link
Contributor

@imatwawana imatwawana left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few minor wording changes. I'm wondering about the location of this. Should it be under Configuration like this:
https://docs.sentry.io/platforms/android/configuration/integrations/fragment/
or these:
https://docs.sentry.io/platforms/javascript/configuration/integrations/

src/platforms/java/common/graphql.mdx Outdated Show resolved Hide resolved
src/platforms/java/common/graphql.mdx Outdated Show resolved Hide resolved
src/platforms/java/common/graphql.mdx Outdated Show resolved Hide resolved
@maciejwalkowiak
Copy link
Contributor Author

Regarding the location - if we decide to move things under "Configuration -> Integrations", then I guess we should move other pages there too? Like this one: https://docs.sentry.io/platforms/java/guides/spring-boot/logging-frameworks/

I have no opinions here and will trust your decision.

@marandaneto
Copy link
Contributor

Regarding the location - if we decide to move things under "Configuration -> Integrations", then I guess we should move other pages there too? Like this one: docs.sentry.io/platforms/java/guides/spring-boot/logging-frameworks

I have no opinions here and will trust your decision.

I guess integrations that have the ability to init the SDK as well can be under "Guides".
When the integration is additional to another SDK/integration setup, could go under integrations.

sentry-graphql should go under integrations IMO, logback and log4j2 too.
logback and log4j2 should also be a guide because they also have the ability to be inited via Appender.

what do you think?

@imatwawana
Copy link
Contributor

imatwawana commented Nov 15, 2021

Regarding the location - if we decide to move things under "Configuration -> Integrations", then I guess we should move other pages there too? Like this one: docs.sentry.io/platforms/java/guides/spring-boot/logging-frameworks
I have no opinions here and will trust your decision.

I guess integrations that have the ability to init the SDK as well can be under "Guides". When the integration is additional to another SDK/integration setup, could go under integrations.

sentry-graphql should go under integrations IMO, logback and log4j2 too. logback and log4j2 should also be a guide because they also have the ability to be inited via Appender.

what do you think?

For logback and log4j2, do you mean that the content should show up as both a guide and as a configuration? That seems like a confusing navigation experience to me.

As for the placement of this content, I just wanted to raise the question of where it should go based on what I was seeing for JavaScript, but I don't feel super strongly about it. If we use this as our guide, does that clarify things at all:
https://docs.sentry.io/contributing/approach/sdk-docs/write-configuration/#integrations

@marandaneto
Copy link
Contributor

marandaneto commented Nov 15, 2021

@imatwawana it's because the content of https://docs.sentry.io/platforms/java/guides/logback/ and https://docs.sentry.io/platforms/java/guides/spring-boot/logging-frameworks/#logback are slightly different, the same for log4j2.
or we merge them in a single page, but there's a difference when setting them up standalone or alongside Spring boot.
so what do you think? I believe it should go under integrations as suggested before.
we can move logback and log4j2 if agreed on another PR, so we don't block this one

@imatwawana
Copy link
Contributor

@imatwawana it's because the content of https://docs.sentry.io/platforms/java/guides/logback/ and https://docs.sentry.io/platforms/java/guides/spring-boot/logging-frameworks/#logback are slightly different, the same for log4j2. or we merge them in a single page, but there's a difference when setting them up standalone or alongside Spring boot. so what do you think? I believe it should go under integrations as suggested before. we can move logback and log4j2 if agreed on another PR, so we don't block this one

Ah okay. Apologies, I misunderstood. That makes sense to me. So to confirm we're all on the same page:
Move Sentry-graphql page to here: https://docs.sentry.io/platforms/java/configuration/, adding a folder called Integrations to put it in?

And agreed, we can deal with the logging frameworks page on a different PR.

@marandaneto
Copy link
Contributor

@imatwawana it's because the content of docs.sentry.io/platforms/java/guides/logback and docs.sentry.io/platforms/java/guides/spring-boot/logging-frameworks/#logback are slightly different, the same for log4j2. or we merge them in a single page, but there's a difference when setting them up standalone or alongside Spring boot. so what do you think? I believe it should go under integrations as suggested before. we can move logback and log4j2 if agreed on another PR, so we don't block this one

Ah okay. Apologies, I misunderstood. That makes sense to me. So to confirm we're all on the same page: Move Sentry-graphql page to here: docs.sentry.io/platforms/java/configuration, adding a folder called Integrations to put it in?

And agreed, we can deal with the logging frameworks page on a different PR.

exactly.

@maciejwalkowiak
Copy link
Contributor Author

Ok, GrapQL moved under "Integrations". "Integrations" is hidden from logging frameworks guide, as it would display empty page.

@marandaneto marandaneto merged commit 96f86b6 into getsentry:master Nov 19, 2021
@github-actions github-actions bot locked and limited conversation to collaborators Dec 5, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants