Repository navigation
feat(docs): Apply new quick start template to Java quick start guides - #20002
sentry-junior[bot] wants to merge 3 commits into
Conversation
Co-Authored-By: Shannon Anahata <shannon.anahata@sentry.io>
The Spring and Spring Boot pages had an include placed above the frontmatter, and no Java prerequisites include exists. Also put the Send Logs snippet before the integration links. Co-Authored-By: Shannon Anahata <shannon.anahata@sentry.io>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
|
The plan checks Java getting-started page loads, snippet copies, Java 404s, and client errors on those pages. An issue escalates when those page loads fall or Java 404s appear. It also splits page loads for the Spring Boot guide and the Java root guide. Services: Mention PlanWhat changedJava getting-started pages now show a numbered step guide. The steps are Install, Configure, Send Logs, Send Application Metrics, and Verify Your Setup. Configure uses the OpenTelemetry agent by default. The plain SDK setup sits in an expandable titled Not using OpenTelemetry. The onboarding option checkboxes are gone. JUL, Log4j2, Logback, and Servlet share the common Java guide. Spring Boot and Spring have their own guides. sentry-docs must deploy before this change is live. RiskA broken include can blank the Install or Configure snippets on all seven guides. A StepConnector or Expandable fault can throw in the browser on those pages. Readers who skip OpenTelemetry may miss the collapsed setup. A bad internal link can 404 other Java pages. Intended effectThe seven getting-started URLs must keep loading. That is the proof the new step layout is on the live pages. Absent looks like those loads fall below the band while the Java configuration page still loads. Snippet copies on Java docs must also hold. Absent copies with steady loads means the new code blocks are not usable.
JUL, Log4j2, Logback, Servlet, and Spring each had 1-7 loads per 24h. Do not band those paths alone. Keep them inside the combined total. Regression watchWatch 404s on the Java path, client errors on Java docs URLs, snippet copies, and loads on the Java configuration page. A blank getting-started page shows as a 404 or a load drop. A StepConnector or Expandable throw shows as a new error title. Broken code tabs show as snippet copies falling toward 0. The UnhandledRejection title
Not observableThe new heading text has no metric. Plausible |
DESCRIBE YOUR PR
Applies the quick start template from #19295 (Ember) to the Java quick start (
common/index.mdx, which also renders for the JUL, Log4j2, Logback, and Servlet guides) and the Spring Boot and Spring guides. All pages keep their single-column layout.<OnboardingOption>wrappers, and___PRODUCT_OPTION___markers from the Java getting-started includes.sentry-async-profilerdependency is included by default.logs.enabled=true(orsentry.logs.enabled=trueon Spring Boot). Both setup paths include it. Application Metrics need no option.IS YOUR CHANGE URGENT?
PRE-MERGE CHECKLIST
via shannon.anahata.
--
View Junior Session [Sentry]