diff options
Diffstat (limited to 'lib/gitlab/tracking/docs/templates/default.md.haml')
| -rw-r--r-- | lib/gitlab/tracking/docs/templates/default.md.haml | 35 |
1 files changed, 35 insertions, 0 deletions
diff --git a/lib/gitlab/tracking/docs/templates/default.md.haml b/lib/gitlab/tracking/docs/templates/default.md.haml new file mode 100644 index 00000000000..568f56590fa --- /dev/null +++ b/lib/gitlab/tracking/docs/templates/default.md.haml @@ -0,0 +1,35 @@ += auto_generated_comment + +:plain + # Event Dictionary + + This file is autogenerated, please do not edit it directly. + + To generate these files from the GitLab repository, run: + + ```shell + bundle exec rake gitlab:snowplow:generate_event_dictionary + ``` + + The Event Dictionary is based on the following event definition YAML files: + + - [`config/events`](https://gitlab.com/gitlab-org/gitlab/-/tree/f9a404301ca22d038e7b9a9eb08d9c1bbd6c4d84/config/events) + - [`ee/config/events`](https://gitlab.com/gitlab-org/gitlab/-/tree/f9a404301ca22d038e7b9a9eb08d9c1bbd6c4d84/ee/config/events) + + ## Event definitions + +\ +- event_definitions.each do |_path, object| + + = "### `#{object.category} #{object.action}`" + \ + = render_event_taxonomy(object) + \ + = render_description(object) + \ + = render_yaml_definition_path(object) + \ + = render_owner(object) + \ + = render_tiers(object) + \ |