Skip to content

Conversation

@isabellaenriquez
Copy link
Member

@isabellaenriquez isabellaenriquez commented Oct 28, 2024

Adds a section to develop docs for common API docs test errors.

image

@vercel
Copy link

vercel bot commented Oct 28, 2024

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

Name Status Preview Comments Updated (UTC)
changelog ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 31, 2024 4:45pm
develop-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 31, 2024 4:45pm
1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
sentry-docs ⬜️ Ignored (Inspect) Visit Preview Oct 31, 2024 4:45pm

@isabellaenriquez isabellaenriquez changed the title feat(api): troubleshooting tests for publishing [WIP] feat(api): troubleshooting tests for publishing Oct 30, 2024
@isabellaenriquez isabellaenriquez marked this pull request as ready for review October 30, 2024 22:04
@isabellaenriquez isabellaenriquez requested a review from a team October 30, 2024 22:05
makes and merges a PR in `sentry-docs`, which kicks off a deploy via Vercel to
https://docs.sentry.io/api/.

## Troubleshooting API Docs Tests
Copy link
Member

Choose a reason for hiding this comment

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

suggestion: we also get a lot of questions from people that see the diff test fail and think it's a test failure. Would be good to add that here too and say it's supposed to fail to show you the difference between new and old schema.

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 idea!

@isabellaenriquez isabellaenriquez merged commit e6975fc into master Oct 31, 2024
10 checks passed
@isabellaenriquez isabellaenriquez deleted the isabella/api-troubleshoot branch October 31, 2024 16:57
@github-actions github-actions bot locked and limited conversation to collaborators Nov 16, 2024
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