Skip to content

Conversation

phil-snowplow
Copy link
Contributor

@phil-snowplow phil-snowplow commented Aug 19, 2025

Draft PR for new Event Forwarding documentation.

Overview of changes

New event forwarding documentation structure:

  • Updated Main event forwarding page to focus mostly on "event forwarding" as a feature, and then mention and link to "alternative approaches" like Snowbridge, Custom Integrations, and GTM SS
  • Created integrations library overview page (docs/destinations/forwarding-events/integrations/index.md)
  • Added Braze and Amplitude integration docs (docs/destinations/forwarding-events/integrations/braze/index.md)
  • Added reference documentation (docs/destinations/forwarding-events/reference/index.md)
  • Added Create, Manage, and Monitoring and Troubleshooting pages
  • Removed native integrations page and reorganized content
  • Moved Snowbridge docs to Reference

New component:

  • Created EventForwardingSchemaTable React component for displaying default field mapping info

Open questions

  • Instead of waiting to merge changes until the GA release, could we just add preview notice to the top of the relevant pages?
  • This change introduces some inconsistency between the Event Forwarding and warehouse/lake loaders sections: all the details for specific loaders are in API Reference, but for Event Forwarding I'm proposing we bring them up to the main section RESOLVED
  • Should we kill the custom integrations page? Or mark as deprecated? AFAIK, we don't want customers to read directly off the enriched stream anymore. DECISION: leave as is until we support more destinations.
  • Should we break out Error handling and troubleshooting into its own page? DECISION: yes

Still to do

  • Update /docs/fundamentals/destinations/ section to reflect the changes above
  • Write Amplitude page
  • Add more details around troubleshooting?
  • Incorporate screenshots/diagrams
  • Confirm and document what happens to events that hit setup errors
  • Add screenshot of field mapping once UI improvements are implemented
  • [DEFERRED] Update the GTM-SS Braze and Amplitude pages to say deprecated
  • [DEFERRED] update docs/api-reference/failed-events/index.md with new event forwarding failure type

@phil-snowplow phil-snowplow added the do not merge Flag to denote a Issue or PR which should not yet be merged (usually pending a release) label Aug 19, 2025
Copy link

netlify bot commented Aug 19, 2025

Deploy Preview for snowplow-docs ready!

Name Link
🔨 Latest commit 08734fe
🔍 Latest deploy log https://app.netlify.com/projects/snowplow-docs/deploys/68efa5009b06df0008895a34
😎 Deploy Preview https://deploy-preview-1371--snowplow-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 7
Accessibility: 91
Best Practices: 92
SEO: 95
PWA: -
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify project configuration.

@mscwilson
Copy link
Collaborator

re Should we break out Error handling and troubleshooting into its own page?

yeah I find it a bit odd to have this section so prominently on the main landing page. A separate page would be good - and consistent with the GTM SS section that has a Testing and debugging page

- **Failure timestamp**: when the error occurred
- **Transformation state**: data state at the point of failure

### Querying failed event logs
Copy link
Collaborator

Choose a reason for hiding this comment

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

is this section AWS only?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

yes, for now. added a callout mentioning that and a todo to add steps for GCP

Copy link
Contributor

Choose a reason for hiding this comment

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

Ticket here - but Phil no objection to you translating them if you'd prefer get it done before we can get to it :)

phil-snowplow and others added 10 commits September 16, 2025 15:56
more updates
commit 9116f4c
Author: spenes <[email protected]>
Date:   Tue Sep 16 15:48:40 2025 +0300

    Enrich 6.1.1

commit eddc40e
Author: Nick <[email protected]>
Date:   Mon Sep 15 12:26:26 2025 +0100

    Add info on running Micro as a jar (#1407)

commit 314e37a
Author: Nick <[email protected]>
Date:   Fri Sep 12 17:22:56 2025 +0100

    Update index.md

commit 6707f4b
Author: jborlase-snowplow <[email protected]>
Date:   Fri Sep 12 17:55:30 2025 +0200

    Removing redundant Snowtype page in GTM (#1405)

commit 7de4d8c
Author: jborlase-snowplow <[email protected]>
Date:   Fri Sep 12 16:59:07 2025 +0200

    Updating Snowtype overview page (#1403)

    * updating Snowtype page

    * fixing casing

    * Update docs/data-product-studio/snowtype/index.md

    Co-authored-by: Nick <[email protected]>

    ---------

    Co-authored-by: Nick <[email protected]>

commit 7f3a45b
Author: Nick <[email protected]>
Date:   Fri Sep 12 15:57:11 2025 +0100

    Add new dedicated pages for warehouses and lakes (#1402)

    * Add new dedicated pages for warehouses and lakes

    * Added a page per each warehouse and lake with key details
    * Explicitly listed the required permissions
    * Added a simplified description of the Snowplow data format for each
    * Moved detailed schema reference to API reference section
    * Removed mentions of Postgres (and some of Synapse) to avoid confusion

    * Rephrase prerequisites to heads up

    * Address review comments

    * Add lake maintenance jobs

commit c08d0aa
Author: spenes <[email protected]>
Date:   Fri Sep 12 17:05:47 2025 +0300

    Databricks Streaming Loader 0.2.0

commit 96daedc
Author: Phil Catterall <[email protected]>
Date:   Thu Sep 11 13:15:17 2025 -0400

    fix margin to adjust for grid (#1396)

    * fix margin to adjust for grid

    * fix table and list margins

    * forgot about ordered lists

commit c024007
Author: Nick <[email protected]>
Date:   Thu Sep 11 11:39:58 2025 +0100

    No 🍪 in my 🖨️ please (#1400)
Copy link
Collaborator

@mscwilson mscwilson left a comment

Choose a reason for hiding this comment

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

lgtm!

@phil-snowplow phil-snowplow removed the do not merge Flag to denote a Issue or PR which should not yet be merged (usually pending a release) label Oct 15, 2025
@phil-snowplow phil-snowplow merged commit 765f4fd into main Oct 15, 2025
3 of 4 checks passed
@phil-snowplow phil-snowplow deleted the event-forwarding branch October 15, 2025 13:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants