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

Migrate guide content #1952

Merged
merged 11 commits into from
Jul 31, 2020
Merged

Migrate guide content #1952

merged 11 commits into from
Jul 31, 2020

Conversation

PeloWriter
Copy link
Contributor

I've migrated the guides and tutorials to Gatsby. Visual inspection completed. Looks like all the images and formats are working properly.

- The `Environment` where your code is deployed and running in which you'd like the alert rule applied.
- The `Actions` that should be taken when the associated conditions are met. Mainly -- where you'd like to channel this alert.

#### **Creating a good set of alert rules means:**
Copy link
Member

Choose a reason for hiding this comment

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

guessing we're bolding these for styling? technically we shouldn't need to do that when its a header

Copy link
Member

@dcramer dcramer left a comment

Choose a reason for hiding this comment

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

looks good. some stuff we might wanna check on styling, and a lot of nitpicks that look like they were already present (i wouldnt worry about them, can be fixed another time)

A tag-based condition can be used as the sole condition for an alert rule or in conjunction with additional conditions to fine tune the rule:

![Alert Rule Event Tags](alerts_notifications_11.png)
> In this rule we're leveraging custom tags that our developers added through the Sentry SDK, telling Sentry to notify us via our _#sentry-urgent_ **Slack** channel when _Enterprise_ customers are experiencing errors in critical parts of our application.
Copy link
Member

Choose a reason for hiding this comment

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

out of habit im almost always put newlines between blocks just to ensure it doesnt do something weird. i haven't used this syntax before though so as long as you verified its rendering it should be fine.


```
An event's tags match {key} {match} {value}
```
Copy link
Member

Choose a reason for hiding this comment

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

extra leading whitespace


Sentry provides two threshold conditions based either on the event occurrence or number of affected users:

```
Copy link
Member

Choose a reason for hiding this comment

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

any reason to not use a list? seems odd to put in a codeblock


Every Issue in Sentry has a defined state - _Unresolved_, _Resolved_ or _Ignored_. Read about [Issue States](/workflow/notifications/#issue-states) for more information.

#### **1. Regression Alert**
Copy link
Member

Choose a reason for hiding this comment

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

i dont think we should use numerical prefixes in headers, especially in this kind of case


- **Issue Resolved** - When a new issue is spotted in your code, it's marked with an `unresolved` state. The state changes to `resolved` when a project team member resolves it (either by manually changing its state in the UI or by [submitting a fix](/workflow/releases/?platform=browser#after-associating-commits)) or when the project’s auto-resolve feature is configured. Once the state changes to resolved, an email is sent to all project team members.

![Workflow Issue Resolved Alert](alerts_notifications_04.png)
Copy link
Member

Choose a reason for hiding this comment

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

indentation might break things, but if you verified its fine. either way i would just not indent when its not supposed to be


Configuring the release version ID on the SDK will associate every error that happens in your application runtime with a specific release version of your code. This way you know exactly when an error was introduced into your source code. It also unlocks these powerful features and workflows:

1. **Suspect Commits & Suggested Assignee** - With a release in place, Sentry can suggest suspect commits that might have an introduced the error to your code and through that commit also suggest the author as an assignee.
Copy link
Member

Choose a reason for hiding this comment

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

not ordered

@@ -0,0 +1,119 @@
[Getting started](/error-reporting/quickstart/?platform=node) with Sentry error monitoring is easy and straightforward. In this post, we will provide the recommended ToDos checklist for setting up your Sentry organization account and making the most of it.

## 1. Enable Single Sign-On Access
Copy link
Member

Choose a reason for hiding this comment

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

more numbers in headers makin me sad


![Create a Project](08.png)

### > **What's in a Project?**
Copy link
Member

Choose a reason for hiding this comment

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

do we really need this > notation here?

2. Set the match logic and its fingerprint for it, in your Project's Settings.


### 1. Identify Match Logic
Copy link
Member

Choose a reason for hiding this comment

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

similar, numbers in headers

## Best Practices

* [Set up your Sentry Account](/guides/getting-started/)

Copy link
Member

Choose a reason for hiding this comment

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

not sure whhat this does with the empty line, but might mess up rendering

Copy link
Member

Choose a reason for hiding this comment

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

also future note: we need to make it so we can auto generate child toc

@PeloWriter PeloWriter merged commit 886dcdc into master Jul 31, 2020
@PeloWriter PeloWriter deleted the update/migrate-guides branch July 31, 2020 16:13
@github-actions github-actions bot locked and limited conversation to collaborators Dec 16, 2020
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