Skip to content

Commit d0fb67d

Browse files
Remove BDP wording (#1436)
* 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]>
1 parent 15629da commit d0fb67d

File tree

150 files changed

+592
-775
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

150 files changed

+592
-775
lines changed

.github/styles/Snowplow/Acronyms.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ exceptions:
6565
- ZIP
6666

6767
# Added for Snowplow
68-
- BDP
68+
- CDI
6969
- DNS
7070
- SQS
7171
- UUID

.github/styles/config/vocabularies/snowplow/accept.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ Data Product Studio
5353
Data Model Packs
5454
Data Model Pack
5555
AWS Console
56-
BDP Console
56+
Snowplow Console
5757
Iglu Central
5858
Iglu Server
5959
Igluctl

CLAUDE.md

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@
4848
* Mix prose and lists appropriately: use prose to explain concepts, lists for configuration options or step-by-step items
4949

5050
### Snowplow terminology
51-
* **Capitalized**: Data Product Studio, Snowtype, Snowplow BDP, Signals
51+
* **Capitalized**: Data Product Studio, Snowtype, Snowplow CDI, Signals
5252
* **Context-capitalized**: Collector, Enrich, specific Loaders
5353
* **Not capitalized**: entities, events, schemas, data structures
5454
* Use "entity" not "context", "self-describing event" not "unstructured event"
@@ -120,11 +120,6 @@ Important cautions about data loss, security, or breaking changes
120120
* **Tip**: performance improvements, recommended workflows, pro tips
121121
* **Warning**: data loss risks, security considerations
122122

123-
### BDP vs self-hosted
124-
* Mark BDP-only features in frontmatter: `sidebar_custom_props: offerings: - bdp`
125-
* Note when BDP provides built-in functionality, mention self-hosted alternatives
126-
* **Do not mention "Community Edition"** - use "self-hosted" instead but otherwise prefer not to mention
127-
128123
### Images
129124
* Formats: `.webp` (preferred), `.png`, `.jpg`
130125
* Descriptive filenames and alt text

README.md

Lines changed: 0 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@ This is the source for https://docs.snowplow.io/docs.
1010
- [Organizing content](#organizing-content)
1111
- [Sidebar](#sidebar)
1212
- [Updating sidebar attributes for multiple sections at once](#updating-sidebar-attributes-for-multiple-sections-at-once)
13-
- [Offerings](#offerings)
1413
- [Links](#links)
1514
- [Concepts](#concepts)
1615
- [Reusable fragments](#reusable-fragments)
@@ -143,26 +142,6 @@ It'll update the `index.md` files as appropriate.
143142

144143
You can now delete the `update_attributes_here.txt` file.
145144

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-
166145
### Links
167146

168147
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.

docs/account-management/index.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,23 +4,21 @@ date: "2020-02-15"
44
sidebar_position: 9
55
sidebar_custom_props:
66
header: " "
7-
offerings:
8-
- bdp
97
sidebar_label: "Account management"
108
---
119

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.
1311

1412
## Credentials API
1513

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.
1715

1816
The process for creating a key has been improved over time. We recommend using the v3 process.
1917

2018

2119
### Version 3
2220

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):
2422

2523
![](images/accessing-generated-api-keys.png)
2624

@@ -95,10 +93,10 @@ Authenticating with v2 only required the API key secret. While this method and t
9593

9694
### Version 1
9795

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:
9997

10098
![](images/image-2.png)
10199

102-
Legacy Snowplow BDP credentials management
100+
Legacy Snowplow credentials management
103101

104102
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.

docs/account-management/managing-permissions/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ To set a users permissions, navigate to `Manage users` and then to the user whos
88

99
## What permissions can be set?
1010

11-
Snowplow BDP Console sets permissions for each area of Console as summarized below:
11+
Snowplow Console sets permissions for each area of Console as summarized below:
1212

1313
| **Console feature** | **Description** | **Possible permissions** |
1414
| ------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |

docs/api-reference/enrichment-components/configuration-reference/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@ To accept the terms of license and run Enrich, set the `ACCEPT_LIMITED_USE_LICEN
3232
| `monitoring.metrics.statsd.prefix` | Optional. Default: `snowplow.enrich`. Pefix of StatsD metric names. |
3333
| `monitoring.healthProbe.port` (since *6.0.0*) | Optional. Default: `8000`. Open a HTTP server that returns OK only if the app is healthy. |
3434
| `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. |
3737
| `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. |
3838
| `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. |
3939
| `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. |

docs/api-reference/failed-events/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ In order for an event to be processed successfully:
3232

3333
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.
3434

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.
3636

3737
Next, check the tracking code in your custom application, and make sure the entities you are sending conform to the schema definition.
3838

docs/api-reference/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,4 @@ sidebar_label: "Reference"
77

88
This section contains detailed technical information about Snowplow components.
99

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.

docs/api-reference/loaders-storage-targets/databricks-streaming-loader/configuration-reference/_common_config.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -94,11 +94,11 @@ import Link from '@docusaurus/Link';
9494
</tr>
9595
<tr>
9696
<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>
9898
</tr>
9999
<tr>
100100
<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>
102102
</tr>
103103
<tr>
104104
<td><code>http.client.maxConnectionsPerServer</code></td>

0 commit comments

Comments
 (0)