Skip to content

Commit

Permalink
Update/architecture sdk dev interface (#982)
Browse files Browse the repository at this point in the history
Changed SDK Development Interface docs to fit two tier architecture.
  • Loading branch information
MimiDumpling authored May 16, 2019
1 parent e9db45b commit 8891bd5
Show file tree
Hide file tree
Showing 23 changed files with 1,133 additions and 1,136 deletions.
13 changes: 0 additions & 13 deletions __tests__/__snapshots__/documentation.js.snap
Original file line number Diff line number Diff line change
Expand Up @@ -242,20 +242,7 @@ Array [
"development/sdk-dev/data-handling/index.html",
"development/sdk-dev/features/index.html",
"development/sdk-dev/index.html",
"development/sdk-dev/interfaces/breadcrumbs/index.html",
"development/sdk-dev/interfaces/contexts/index.html",
"development/sdk-dev/interfaces/debug/index.html",
"development/sdk-dev/interfaces/exception/index.html",
"development/sdk-dev/interfaces/gpu/index.html",
"development/sdk-dev/interfaces/http/index.html",
"development/sdk-dev/interfaces/index.html",
"development/sdk-dev/interfaces/mechanism/index.html",
"development/sdk-dev/interfaces/message/index.html",
"development/sdk-dev/interfaces/sdk/index.html",
"development/sdk-dev/interfaces/stacktrace/index.html",
"development/sdk-dev/interfaces/template/index.html",
"development/sdk-dev/interfaces/threads/index.html",
"development/sdk-dev/interfaces/user/index.html",
"development/sdk-dev/overview/index.html",
"development/sdk-dev/unified-api/index.html",
"enriching-error-data/breadcrumbs/index.html",
Expand Down
52 changes: 52 additions & 0 deletions nginx.conf
Original file line number Diff line number Diff line change
Expand Up @@ -397,6 +397,58 @@ server {

location = /workflow/integrations/legacy-integrations/asana/ {
return 302 /workflow/integrations/legacy-integrations/;
}

location = /development/sdk-dev/interfaces/breadcrumbs/ {
return 302 /development/sdk-dev/interfaces/;
}

location = /development/sdk-dev/interfaces/contexts/ {
return 302 /development/sdk-dev/interfaces/;
}

location = /development/sdk-dev/interfaces/debug/ {
return 302 /development/sdk-dev/interfaces/;
}

location = /development/sdk-dev/interfaces/exception/ {
return 302 /development/sdk-dev/interfaces/;
}

location = /development/sdk-dev/interfaces/gpu/ {
return 302 /development/sdk-dev/interfaces/;
}

location = /development/sdk-dev/interfaces/http/ {
return 302 /development/sdk-dev/interfaces/;
}

location = /development/sdk-dev/interfaces/mechanism/ {
return 302 /development/sdk-dev/interfaces/;
}

location = /development/sdk-dev/interfaces/message/ {
return 302 /development/sdk-dev/interfaces/;
}

location = /development/sdk-dev/interfaces/sdk/ {
return 302 /development/sdk-dev/interfaces/;
}

location = /development/sdk-dev/interfaces/stacktrace/ {
return 302 /development/sdk-dev/interfaces/;
}

location = /development/sdk-dev/interfaces/template/ {
return 302 /development/sdk-dev/interfaces/;
}

location = /development/sdk-dev/interfaces/threads/ {
return 302 /development/sdk-dev/interfaces/;
}

location = /development/sdk-dev/interfaces/user/ {
return 302 /development/sdk-dev/interfaces/;
}

location / {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ If you want to manually record breadcrumbs the most convenient way to do that is

{: #raven.breadcrumbs.record}`raven.breadcrumbs.``record`(_**options_)

: This function accepts keyword arguments matching the attributes of a breadcrumb. For more information see [_Interfaces_]({%- link _documentation/development/sdk-dev/interfaces/index.md -%}). Additionally a _processor_ callback can be passed which will be invoked to process the data if the crumb was not rejected.
: This function accepts keyword arguments matching the attributes of a breadcrumb. For more information see [_Interfaces_]({%- link _documentation/development/sdk-dev/interfaces.md -%}). Additionally a _processor_ callback can be passed which will be invoked to process the data if the crumb was not rejected.

The most important parameters:

Expand Down
2 changes: 1 addition & 1 deletion src/collections/_documentation/data-management/rollups.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ The structured data of an event dictates how a rollup is created. This varies de

## Grouping Priorities

The grouping switches behavior based on the interfaces ([_Interfaces_]({%- link _documentation/development/sdk-dev/interfaces/index.md -%})) that are available within an event.
The grouping switches behavior based on the interfaces ([_Interfaces_]({%- link _documentation/development/sdk-dev/interfaces.md -%})) that are available within an event.

- If the interfaces used in an event differ, then those events will not be grouped together.
- If a stack trace or exception is involved in a report, then grouping will only consider this information.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ information about events. These are things like the unique ID of an event, the
human readable message etc.

Attributes are separate from [_Interfaces_]({%- link
_documentation/development/sdk-dev/interfaces/index.md -%}) which provide very specific
_documentation/development/sdk-dev/interfaces.md -%}) which provide very specific
and tailored data such as exception data, stack traces, etc.

## Required Attributes
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,5 @@ typically look and behave.
- [Unified API]({%- link _documentation/development/sdk-dev/unified-api.md -%})
- [Expected Features]({%- link _documentation/development/sdk-dev/features.md -%})
- [Attributes]({%- link _documentation/development/sdk-dev/attributes.md -%})
- [Interfaces]({%- link _documentation/development/sdk-dev/interfaces/index.md -%})
- [Interfaces]({%- link _documentation/development/sdk-dev/interfaces.md -%})
- [Data Handling]({%- link _documentation/development/sdk-dev/data-handling.md -%})
Loading

0 comments on commit 8891bd5

Please sign in to comment.