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

Fix logger API page #1580

Merged
merged 4 commits into from
Sep 2, 2021
Merged

Fix logger API page #1580

merged 4 commits into from
Sep 2, 2021

Conversation

zstix
Copy link
Contributor

@zstix zstix commented Sep 1, 2021

Description

This PR adds a few fixes to reduce the number of errors on the developer site. More specifically, this removes:

  • The warning that we needed a unique key for the <meta> tags coming from our SEO component
  • The warning coming from the logger API page (due to the SDK being in a weird state - see screenshots)

Screenshot(s)

It looks like the SDK for the logger API is mostly incomplete. A number of the adjustments in the PR were defensive adjustments to get the page to render without errors. That said, it's still pretty incomplete:

Screen Shot 2021-09-01 at 16 19 31

It's worth noting that, in most cases, this will always be present. This
is mostly just a precaution for times when the SDK is not formatted in a
way that our code expects. At the time of commit, the `logger` API
documentation is returning `null` descriptions.
@zstix zstix changed the title Zstix/fix logger doc Fix logger API page Sep 1, 2021
@gatsby-cloud
Copy link

gatsby-cloud bot commented Sep 1, 2021

Gatsby Cloud Build Report

developer-website-develop

🎉 Your build was successful! See the Deploy preview here.

Build Details

View the build logs here.

🕐 Build time: 2m

Performance

Lighthouse report

Metric Score
Performance 🔶 33
Accessibility 🔶 88
Best Practices 🔶 87
SEO 🔶 76

🔗 View full report

@zstix zstix force-pushed the zstix/fix-logger-doc branch from cb5e319 to 053becf Compare September 2, 2021 21:39
@zstix zstix merged commit 085c02d into develop Sep 2, 2021
@zstix zstix deleted the zstix/fix-logger-doc branch September 2, 2021 22:33
@nr-opensource-bot
Copy link
Contributor

🎉 This PR is included in version 1.52.2 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants