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

Docs refactor to match new commercial offering #1012

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 0 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,25 +48,6 @@ The sidebar on the left follows [file structure](https://github.com/snowplow/doc

To control the position of a section in the sidebar, go to the `index.md` file for that section and adjust the `sidebar_position` attribute at the top (see [this example](https://github.com/snowplow/documentation/blob/main/docs/tutorials/index.md)). Sidebar positions are just numbers, and you can use any number as long as the order is correct.

### Offerings

Some documentation is only relevant to a particular offering. You can indicate it like this:
```
---
title: ...
...
sidebar_custom_props:
offerings:
- bdp
...
---
```

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.

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.

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.

### Links

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ The Snowplow Node.js Tracker allows you to track Snowplow events from your Nod
The tracker should be straightforward to use if you are comfortable with JavaScript development; any prior experience with other Snowplow trackers is helpful but not necessary.


---

```mdx-code-block
import DocCardList from '@theme/DocCardList';
Expand Down
3 changes: 0 additions & 3 deletions docs/collecting-data/configuring-collector/manual/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,6 @@
title: "Configuring the Collector for Community Edition users"
sidebar_label: "Using the config file"
sidebar_position: 20
sidebar_custom_props:
offerings:
- community
---

After you have installed the [Collector](/docs/pipeline-components-and-applications/stream-collector/index.md) (either following the [Quick Start guide](/docs/getting-started-on-community-edition/what-is-quick-start/index.md) or [manually](/docs/pipeline-components-and-applications/stream-collector/setup/index.md)), you can follow the [reference page](/docs/pipeline-components-and-applications/stream-collector/configure/index.md) to configure it.
3 changes: 0 additions & 3 deletions docs/collecting-data/configuring-collector/ui/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,6 @@ title: "Configuring the Collector in Snowplow BDP"
date: "2020-08-10"
sidebar_label: "Using the UI or API"
sidebar_position: 10
sidebar_custom_props:
offerings:
- bdp
---

Having already set up [collectors in your pipeline](/docs/understanding-your-pipeline/architecture-overview/index.md) and trackers [to submit events](/docs/collecting-data/index.md) to them, you may want to verify your collector configuration. This can take two forms, depending on your needs.
Expand Down
2 changes: 0 additions & 2 deletions docs/collecting-data/first-party-tracking/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@
title: "First-party tracking"
sidebar_position: 40
sidebar_custom_props:
offerings:
- bdp
# hide from sidebar and external search until these instructions apply more universally
hidden: true
---
Expand Down
5 changes: 1 addition & 4 deletions docs/data-apps/index.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,7 @@
---
title: "Data Applications"
sidebar_position: 112
sidebar_label: "🆕 Data Applications"
sidebar_custom_props:
offerings:
- bdp
sidebar_label: "Data Applications"
---

```mdx-code-block
Expand Down
3 changes: 0 additions & 3 deletions docs/discovering-data/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,6 @@ title: "Discovering data"
date: "2022-10-26"
sidebar_position: 111
sidebar_label: "Discovering data"
sidebar_custom_props:
offerings:
- bdp
---

```mdx-code-block
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,6 @@ title: "Managing enrichments in Snowplow Community Edition"
date: "2021-10-06"
sidebar_label: "Using Terraform"
sidebar_position: 15
sidebar_custom_props:
offerings:
- community
---

If you have installed Snowplow via [Quick Start](/docs/getting-started-on-community-edition/what-is-quick-start/index.md), you will have the following enrichments enabled by default:
Expand Down
3 changes: 0 additions & 3 deletions docs/enriching-your-data/managing-enrichments/ui/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,6 @@ title: "Managing enrichments in BDP Console"
date: "2020-02-15"
sidebar_label: "Using the UI"
sidebar_position: 10
sidebar_custom_props:
offerings:
- bdp
---

Snowplow Console enables you to manage the Enrichments that run on each of your environments.
Expand Down
2 changes: 0 additions & 2 deletions docs/getting-started-on-bdp/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@ sidebar_position: 6
sidebar_label: "Setting up Snowplow BDP"
sidebar_custom_props:
header: "Installing Snowplow"
offerings:
- bdp
---

```mdx-code-block
Expand Down
3 changes: 0 additions & 3 deletions docs/getting-started-on-community-edition/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,6 @@ title: "Setting up Snowplow Community Edition"
date: "2020-10-30"
sidebar_position: 8
sidebar_label: "Setting up Community Edition"
sidebar_custom_props:
offerings:
- community
---

```mdx-code-block
Expand Down
3 changes: 0 additions & 3 deletions docs/managing-data-quality/monitoring-failed-events/index.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
---
title: "Monitoring failed events"
sidebar_position: 2
sidebar_custom_props:
offerings:
- bdp
---

```mdx-code-block
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,6 @@ title: "Using the Recovery Builder to design your recovery"
date: "2021-10-13"
sidebar_label: "Using the Recovery Builder"
sidebar_position: 0
sidebar_custom_props:
offerings:
- bdp
---

### What is the Recovery Builder?
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,6 @@ title: "Event Recovery for Community Edition"
date: "2020-07-02"
sidebar_label: "Using Flink/Spark"
sidebar_position: 40
sidebar_custom_props:
offerings:
- community
---

Snowplow pipelines are "non-lossy", this means if something is wrong with an event during any part of the pipeline, the event is stored in a separate storage environment rather than just discarded. See the [failed events section](/docs/understanding-your-pipeline/failed-events/index.md) for more information on the types of failures that may occur.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,6 @@
title: "Using the Data Structures CI tool"
date: "2020-06-01"
sidebar_position: 2000
sidebar_custom_props:
offerings:
- bdp
---

The Data Structures CI is a command-line tool which integrates Data Structures API into your CI/CD pipelines and currently has one task which verifies that all schema dependencies for a project are already deployed into a specified environment (e.g. "DEV", "PROD").
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,6 @@ date: "2020-12-01"
sidebar_position: 30
description: "Guides to run data models in Snowplow BDP, both dbt and SQL Runner."
sidebar_label: "Running data models in BDP"
sidebar_custom_props:
offerings:
- bdp
---

```mdx-code-block
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,6 @@
title: "Managing Data Products via the API"
sidebar_label: "Using the API"
sidebar_position: 3
sidebar_custom_props:
offerings:
- bdp
---

As well as managing [data products](/docs/understanding-tracking-design/defining-the-data-to-collect-with-data-poducts/index.md) through the Snowplow BDP Console, Snowplow BDP customers can also manage them programmatically through an API.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,6 @@ title: "Data product templates"
date: "2024-06-17"
sidebar_label: "Using data product templates"
sidebar_position: 2
sidebar_custom_props:
offerings:
- bdp
---

## Creating a Data Product based on Templates using Console
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,6 @@ title: "Managing Data Product using Console"
date: "2024-01-18"
sidebar_label: "Using the UI"
sidebar_position: 1
sidebar_custom_props:
offerings:
- bdp
---

## Creating and editing a new Data Product using Console
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,6 @@
title: "Managing Event Specifications via the API"
sidebar_label: "Using the API"
sidebar_position: 2
sidebar_custom_props:
offerings:
- bdp
---

With the [**Event Specifications API**](https://console.snowplowanalytics.com/api/msc/v1/docs), you can efficiently manage event specifications programmatically. Whether you want to retrieve, create, edit, publish, deprecate, or delete event specifications, the API provides the necessary endpoints and functionalities.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,6 @@
title: "Managing Event Specifications"
sidebar_label: "Managing Event Specifications"
sidebar_position: 95
sidebar_custom_props:
offerings:
- bdp
---

```mdx-code-block
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,6 @@
title: "Managing Event Specifications in the Console"
sidebar_label: "Using the UI"
sidebar_position: 1
sidebar_custom_props:
offerings:
- bdp
---

## Creating a new Event Specification through Console
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,6 @@
title: "Managing data structures via the API"
sidebar_label: "Using the API"
sidebar_position: 2
sidebar_custom_props:
offerings:
- bdp
---

As well as managing [data structures](/docs/understanding-your-pipeline/schemas/index.md) through the Snowplow BDP Console, Snowplow BDP customers can also manage them programmatically through the data structures API.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,6 @@ title: "Managing schemas using Iglu"
date: "2020-02-15"
sidebar_label: "Using Iglu"
sidebar_position: 4
sidebar_custom_props:
offerings:
- community
---

## Setup
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,6 @@ title: "Managing data structures in the console"
date: "2020-02-15"
sidebar_label: "Using the UI"
sidebar_position: 1
sidebar_custom_props:
offerings:
- bdp
---

## Creating a new data structure
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,6 @@ title: "Managing data structures with the JSON Editor"
description: "The JSON editor is best suited for defining complex data structures that require heavy nesting and advanced data types."
sidebar_label: "Using the JSON Editor"
sidebar_position: 1
sidebar_custom_props:
offerings:
- bdp
---

:::info
Expand Down
3 changes: 0 additions & 3 deletions docs/understanding-tracking-design/tracking-plans/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,6 @@
title: "Creating a tracking plan with event specifications"
sidebar_label: "Creating a tracking plan"
sidebar_position: 25
sidebar_custom_props:
offerings:
- bdp
---

As explained in [Introduction to tracking design](/docs/understanding-tracking-design/introduction-to-tracking-design/index.md), to use Snowplow successfully, you need to have a good idea of:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,6 @@ title: "Versioning Data Structures with the Data Structures Builder"
date: "2023-03-01"
sidebar_label: "Using the Data Structures Builder"
sidebar_position: 20
sidebar_custom_props:
offerings:
- bdp
---

# Versioning with the Data Structures Builder
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,6 @@
title: "Versioning Data Structures with the JSON Editor"
sidebar_label: "Using the JSON Editor"
sidebar_position: 10
sidebar_custom_props:
offerings:
- bdp
---

## How do I version?
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,6 @@
title: "Versioning Data Structures using Iglu"
sidebar_label: "Using Iglu"
sidebar_position: 30
sidebar_custom_props:
offerings:
- community
---

## How do I version?
Expand Down
3 changes: 0 additions & 3 deletions docs/using-the-snowplow-console/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,6 @@
title: "Managing your account"
date: "2020-02-15"
sidebar_position: 120
sidebar_custom_props:
offerings:
- bdp
---

```mdx-code-block
Expand Down