Skip to content

Add documentation for InternalEventsTracking module

Jonas Larsen requested to merge 435200-add-documentation into master

What does this MR do and why?

In !142658 (merged) we introduced a module that automatically sets the category of Snowplow events based on where the track method is called.

This MR updates the documentation and the usage examples of the generator to use the module instead of the InternalEvents.track_event method.

MR acceptance checklist

Please evaluate this MR against the MR acceptance checklist. It helps you analyze changes to reduce risks in quality, performance, reliability, security, and maintainability.

How to set up and validate locally

To test the changes to the generator:

  1. Start the generator: ruby scripts/internal_events/cli.rb
  2. Select 3. View Usage
  3. Select an event
  4. Select 1. ruby/rails
  5. Verify that the example is using the module.

Related to #435200 (closed)

Edited by Jonas Larsen

Merge request reports