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 basic API tutorials #7433

Merged
merged 38 commits into from
Aug 8, 2023
Merged

Add basic API tutorials #7433

merged 38 commits into from
Aug 8, 2023

Conversation

shanamatthews
Copy link
Contributor

@shanamatthews shanamatthews commented Jul 13, 2023

Pre-merge checklist

If you work at Sentry, you're able to merge your own PR without review, but please don't unless there's a good reason.

  • Checked Vercel preview for correctness, including links
  • PR was reviewed and approved by any necessary SMEs
  • PR was reviewed and approved by a member of the Sentry docs team

Description of changes

Basic tutorial for using the List an Organization's Teams and Create a New Team endpoints.

Links:

"Create and Configure a Project with the Sentry API" guide is currently an outline and not ready for review

Todo:

  • Add screenshots/Arcades
  • Split get token into separate tutorial & link??
  • Make sidebar section for tutorials
  • how to duplicate a project
  • add in placeholders for endpoints that don't exist

@vercel
Copy link

vercel bot commented Jul 13, 2023

You must have Developer access to commit code to Sentry on Vercel. If you contact an administrator and receive Developer access, commit again to see your changes.

Learn more: https://vercel.com/docs/concepts/teams/roles-and-permissions#enterprise-team-account-roles

@shanamatthews shanamatthews marked this pull request as draft July 13, 2023 23:21
@vercel
Copy link

vercel bot commented Jul 13, 2023

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

Name Status Preview Comments Updated (UTC)
sentry-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 8, 2023 10:12pm

@shanamatthews shanamatthews changed the title Draft API tutorials Add basic API tutorials Aug 1, 2023
@shanamatthews shanamatthews marked this pull request as ready for review August 1, 2023 00:01
@sentaur-athena
Copy link
Member

@shanamatthews I can't see the links to your dev env, is it possible to access it or include screenshots here to review?


1. Open [sentry.io](https://sentry.io/)

1. Click "Settings" in the left menu to open the **Organization Settings** page.
Copy link
Member

Choose a reason for hiding this comment

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

Why are these all 1?

Copy link
Contributor Author

@shanamatthews shanamatthews Aug 1, 2023

Choose a reason for hiding this comment

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

Markdown doesn't care about the number, it automatically renders an ordered list with the correct numbers. https://www.markdownguide.org/basic-syntax/#ordered-lists

I prefer to use all 1s as it's easier to add/remove steps later.

@shanamatthews
Copy link
Contributor Author

shanamatthews commented Aug 1, 2023

@shanamatthews I can't see the links to your dev env, is it possible to access it or include screenshots here to review?

@sentaur-athena Hmm, you need Vercel access. I thought folks got it by default but maybe not.
Try this?

Vercel Access

To join Vercel, visit this link: http://vercel.com/teams/invite/Y3EF7uU8.

Preview Builds

Vercel allows you to view preview builds of your branch when you create a PR. However, you will need to make a Vercel account by linking your Github then joining the Sentry team on Vercel.

@shanamatthews shanamatthews enabled auto-merge (squash) August 8, 2023 21:56
@shanamatthews shanamatthews merged commit ee59760 into master Aug 8, 2023
6 checks passed
@shanamatthews shanamatthews deleted the shana/api-tutorials branch August 8, 2023 22:04
@github-actions github-actions bot locked and limited conversation to collaborators Aug 24, 2023
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.

2 participants