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

Streamline kotlin onboarding docs #57342

Merged
merged 3 commits into from
Oct 9, 2023

Conversation

adinauer
Copy link
Member

@adinauer adinauer commented Oct 3, 2023

Last missing piece to close getsentry/sentry-java#2885

Move performance into "Next Steps", Use SAGP and Maven plugin, enable Source Context

@adinauer adinauer requested a review from a team as a code owner October 3, 2023 06:10
@vercel
Copy link

vercel bot commented Oct 3, 2023

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

Name Status Preview Updated (UTC)
sentry ✅ Ready (Inspect) Visit Preview Oct 3, 2023 6:10am

@github-actions github-actions bot added the Scope: Frontend Automatically applied to PRs that change frontend components label Oct 3, 2023
Copy link
Member

@ArthurKnaus ArthurKnaus left a comment

Choose a reason for hiding this comment

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

Nice! 🚀

@adinauer adinauer self-assigned this Oct 3, 2023
additionalInfo: (
<p>
{tct(
'To upload your source code to Sentry so it can be shown in stack traces, please refer to [link:Manually Uploading Source Context].',
Copy link
Contributor

Choose a reason for hiding this comment

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

Should we rewrite this to something like:
"If you prefer to manually upload your source code to Sentry, please refer to..." ?
This also applies to the Java wizard.

Or we could simply delete this part, WDYT?

'To upload your source code to Sentry so it can be shown in stack traces, please refer to [link:Manually Uploading Source Context].',
{
link: (
<ExternalLink href="https://docs.sentry.io/platforms/java/source-context/" />
Copy link
Contributor

Choose a reason for hiding this comment

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

Copy link
Contributor

Choose a reason for hiding this comment

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

The introduction component (line 55) does not show up correctly. This is due to an open bracket that is not closed. Also, the strong component needs to be duplicated in order to work correctly. Here's my suggestion:

const introduction = (
  <p>
    {tct(
      "Sentry supports Kotlin for both JVM and Android. This wizard guides you through set up in the JVM scenario. If you're interested in [strong:Android], head over to the [gettingStartedWithAndroidLink:Getting Started] for that SDK instead. At its core, Sentry for Java provides a raw client for sending events to Sentry. If you use [strong2:Spring Boot, Spring, Logback, JUL, or Log4j2], head over to our [gettingStartedWithJavaLink:Getting Started for Sentry Java].",
      {
        gettingStartedWithAndroidLink: (
          <ExternalLink href="https://docs.sentry.io/platforms/android/" />
        ),
        gettingStartedWithJavaLink: (
          <ExternalLink href="https://docs.sentry.io/platforms/java/" />
        ),
        strong: <strong />,
        strong2: <strong />,
      }
    )}
  </p>
);

Copy link
Member Author

Choose a reason for hiding this comment

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

good catch!

@adinauer adinauer merged commit a562057 into master Oct 9, 2023
41 checks passed
@adinauer adinauer deleted the feat/kotlin-onboarding-docs-streamline branch October 9, 2023 05:59
@github-actions github-actions bot locked and limited conversation to collaborators Oct 24, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Scope: Frontend Automatically applied to PRs that change frontend components
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Streamline and align the "Getting Started" docs to fit in the new structure
3 participants