You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* Update offering banner
* Replace some BDP mentions
* Start updating offerings pages
* Update page describing different offerings
* Tidy up the rest of Get started
* Edit the Snowplow CLI reference
* Update a path
* Remove some more BDPs
* Clarify self-hosted offerings
* Fix doubled words
* Remove BDPs outside of docs folder
* Replace in marketing plugin metadata
* Rework the offerings page again
* Tidy up Glossary links
* Fix links
* Make changes following review
* Completely remove the BDP/CE admons
* remove BDP from event forwarding diagram
* Restore Azure app name
* Restore Azure bits I missed the first time
---------
Co-authored-by: Phil Catterall <[email protected]>
Copy file name to clipboardExpand all lines: README.md
-21Lines changed: 0 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,6 @@ This is the source for https://docs.snowplow.io/docs.
10
10
-[Organizing content](#organizing-content)
11
11
-[Sidebar](#sidebar)
12
12
-[Updating sidebar attributes for multiple sections at once](#updating-sidebar-attributes-for-multiple-sections-at-once)
13
-
-[Offerings](#offerings)
14
13
-[Links](#links)
15
14
-[Concepts](#concepts)
16
15
-[Reusable fragments](#reusable-fragments)
@@ -143,26 +142,6 @@ It'll update the `index.md` files as appropriate.
143
142
144
143
You can now delete the `update_attributes_here.txt` file.
145
144
146
-
### Offerings
147
-
148
-
Some documentation is only relevant to a particular offering. You can indicate it like this:
149
-
```
150
-
---
151
-
title: ...
152
-
...
153
-
sidebar_custom_props:
154
-
offerings:
155
-
- bdp
156
-
...
157
-
---
158
-
```
159
-
160
-
This will result in an icon appearing in the sidebar, as well as an automatic banner on the page, specifying that the docs only apply to a given offering.
161
-
162
-
The available values are: `bdp` and `community`. Do not specify both values at once — if a piece of documentation is relevant to all offerings, there should be no `offerings` property as that’s the default.
163
-
164
-
Whenever the same functionality can be achieved in multiple offerings but in a different way (e.g. managing schemas), create a parent folder (“Managing schemas”) that’s offering-neutral, and then add offering-specific pages inside it. This way, other pages can link to the generic page without having to specify different methods for different offerings.
165
-
166
145
### Links
167
146
168
147
For links within this documentation, please end the link with `/index.md`. This way all links will be checked, and you’ll get an error if a link is broken at any point.
Copy file name to clipboardExpand all lines: docs/account-management/index.md
+5-7Lines changed: 5 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,23 +4,21 @@ date: "2020-02-15"
4
4
sidebar_position: 9
5
5
sidebar_custom_props:
6
6
header: ""
7
-
offerings:
8
-
- bdp
9
7
sidebar_label: "Account management"
10
8
---
11
9
12
-
Manage your account configuration and users using the Snowplow BDP Console. You can also use the underlying API directly. This page describes how to acquire an API key.
10
+
Manage your account configuration and users using the Snowplow Console. You can also use the underlying API directly. This page describes how to acquire an API key.
13
11
14
12
## Credentials API
15
13
16
-
The API that drives BDP Console's functionality is [publicly documented](https://console.snowplowanalytics.com/api/msc/v1/docs/index.html?url=/api/msc/v1/docs/docs.yaml) and available for our customers to invoke via code. All calls to it need to be properly authenticated using JSON Web Tokens (JWT) that can be acquired via the Credentials API.
14
+
The API that drives Console's functionality is [publicly documented](https://console.snowplowanalytics.com/api/msc/v1/docs/index.html?url=/api/msc/v1/docs/docs.yaml) and available for our customers to invoke via code. All calls to it need to be properly authenticated using JSON Web Tokens (JWT) that can be acquired via the Credentials API.
17
15
18
16
The process for creating a key has been improved over time. We recommend using the v3 process.
19
17
20
18
21
19
### Version 3
22
20
23
-
The following view is available to all customers under [BDP Console settings](https://console.snowplowanalytics.com/credentials):
21
+
The following view is available to all customers under [Console settings](https://console.snowplowanalytics.com/credentials):
24
22
25
23

26
24
@@ -95,10 +93,10 @@ Authenticating with v2 only required the API key secret. While this method and t
95
93
96
94
### Version 1
97
95
98
-
Previously, BDP Console was using the Password authentication flow to support machine-to-machine (m2m) applications. Under that scenario a BDP customer had to create a bot user in their account, retrieve a client ID and a client secret, and use all three to acquire a JWT. Customers who have enabled these credentials in the past will see the following panel in their Console account settings:
96
+
Previously, Console was using the Password authentication flow to support machine-to-machine (m2m) applications. Under that scenario a customer had to create a bot user in their account, retrieve a client ID and a client secret, and use all three to acquire a JWT. Customers who have enabled these credentials in the past will see the following panel in their Console account settings:
99
97
100
98

101
99
102
-
Legacy Snowplow BDP credentials management
100
+
Legacy Snowplow credentials management
103
101
104
102
This method and the respective credentials still work for those who have been using them, however we strongly advise that customers upgrade to the current iteration where the only secret to be used by m2m applications is an API key which can be exchanged for a JWT.
Copy file name to clipboardExpand all lines: docs/api-reference/enrichment-components/configuration-reference/index.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -32,8 +32,8 @@ To accept the terms of license and run Enrich, set the `ACCEPT_LIMITED_USE_LICEN
32
32
|`monitoring.metrics.statsd.prefix`| Optional. Default: `snowplow.enrich`. Pefix of StatsD metric names. |
33
33
|`monitoring.healthProbe.port` (since *6.0.0*) | Optional. Default: `8000`. Open a HTTP server that returns OK only if the app is healthy. |
34
34
|`monitoring.healthProbe.unhealthyLatency` (since *6.0.0*) | Optional. Default: `2 minutes`. Health probe becomes unhealthy if any received event is still not fully processed before this cutoff time. |
35
-
|`telemetry.disable`| Optional. Set to `true` to disable [telemetry](/docs/get-started/snowplow-community-edition/telemetry/index.md). |
36
-
|`telemetry.userProvidedId`| Optional. See [here](/docs/get-started/snowplow-community-edition/telemetry/index.md#how-can-i-help) for more information. |
35
+
|`telemetry.disable`| Optional. Set to `true` to disable [telemetry](/docs/get-started/self-hosted/telemetry/index.md). |
36
+
|`telemetry.userProvidedId`| Optional. See [here](/docs/get-started/self-hosted/telemetry/index.md#how-can-i-help) for more information. |
37
37
|`validation.acceptInvalid` (since *6.0.0*) | Optional. Default: `false`. Enrich *3.0.0* introduces the validation of the enriched events against atomic schema before emitting. If set to `false`, a failed event will be emitted instead of the enriched event if validation fails. If set to `true`, invalid enriched events will be emitted, as before. |
38
38
|`validation.atomicFieldsLimits` (since *4.0.0*) | Optional. For the defaults, see [here](https://github.com/snowplow/enrich/blob/master/modules/common/src/main/resources/reference.conf). Configuration for custom maximum atomic fields (strings) length. It's a map-like structure with keys being atomic field names and values being their max allowed length. |
39
39
|`validation.maxJsonDepth` (since *6.0.0*) | Optional. Default: `40`. Maximum allowed depth for the JSON entities in the events. Event will be sent to bad row stream if it contains JSON entity with a depth that exceeds this value. |
Copy file name to clipboardExpand all lines: docs/api-reference/failed-events/index.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -32,7 +32,7 @@ In order for an event to be processed successfully:
32
32
33
33
If your pipeline is generating schema violations, it might mean there is a problem with your tracking, or a problem with your [Iglu resolver](/docs/api-reference/iglu/iglu-resolver/index.md) which lists where schemas should be found. The error details in the schema violation JSON object should give you a hint about what the problem might be.
34
34
35
-
Snowplow BDP customers should check in the Snowplow BDP Console that all data structures are correct and have been [promoted to production](/docs/data-product-studio/data-structures/manage/index.md). Snowplow Community Edition users should check that the Enrichment app is configured with an [Iglu resolver file](/docs/api-reference/iglu/iglu-resolver/index.md) that points to a repository containing the schemas.
35
+
Snowplow customers should check in the Snowplow Console that all data structures are correct and have been [promoted to production](/docs/data-product-studio/data-structures/manage/index.md). Snowplow Self-Hosted users should check that the Enrichment app is configured with an [Iglu resolver file](/docs/api-reference/iglu/iglu-resolver/index.md) that points to a repository containing the schemas.
36
36
37
37
Next, check the tracking code in your custom application, and make sure the entities you are sending conform to the schema definition.
Copy file name to clipboardExpand all lines: docs/api-reference/index.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,4 +7,4 @@ sidebar_label: "Reference"
7
7
8
8
This section contains detailed technical information about Snowplow components.
9
9
10
-
Some of the information is relevant only for [Community Edition](/docs/get-started/snowplow-community-edition/index.md) users, as [Snowplow BDP](/docs/get-started/snowplow-bdp/index.md) customers won't need to configure all their own components.
10
+
Some of the information is relevant only for [Snowplow Self-Hosted](/docs/get-started/index.md#self-hosted) users, as [Snowplow CDI](/docs/get-started/index.md#customer-data-infrastructure) customers won't need to configure all their own components.
Copy file name to clipboardExpand all lines: docs/api-reference/loaders-storage-targets/databricks-streaming-loader/configuration-reference/_common_config.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -94,11 +94,11 @@ import Link from '@docusaurus/Link';
94
94
</tr>
95
95
<tr>
96
96
<td><code>telemetry.disable</code></td>
97
-
<td>Optional. Set to <code>true</code> to disable <Link to="/docs/get-started/snowplow-community-edition/telemetry/">telemetry</Link>.</td>
97
+
<td>Optional. Set to <code>true</code> to disable <Link to="/docs/get-started/self-hosted/telemetry/">telemetry</Link>.</td>
98
98
</tr>
99
99
<tr>
100
100
<td><code>telemetry.userProvidedId</code></td>
101
-
<td>Optional. See <Link to="/docs/get-started/snowplow-community-edition/telemetry/#how-can-i-help">here</Link> for more information.</td>
101
+
<td>Optional. See <Link to="/docs/get-started/self-hosted/telemetry/#how-can-i-help">here</Link> for more information.</td>
0 commit comments