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

Analytics docs clean up #1841

Closed
11 tasks
thekaveman opened this issue Jan 2, 2024 · 0 comments · Fixed by #1846
Closed
11 tasks

Analytics docs clean up #1841

thekaveman opened this issue Jan 2, 2024 · 0 comments · Fixed by #1846
Assignees
Labels
documentation [auto] Improvements or additions to documentation

Comments

@thekaveman
Copy link
Member

thekaveman commented Jan 2, 2024

Minor follow-ups to #953

In general this page is great and provides a lot of explanation of what our analytics are measuring. However it is written assuming familiarity with how Amplitude organizes event information. We want this language to be slightly more generic and descriptive for anyone unfamiliar with Amplitude.

Acceptance Criteria

  • Alphabetize the Default user properties list
  • Convert Default user properties list to table, similar to Custom user properties, with description and example values
  • Describe app properties in Default user properties list: while these are captured under (Amplitude's) User Properties, they don't correspond to any real User info, instead describing the app itself:
    • Start version: First version of application identified for the user
    • Version: Current version of application identified for the user
    • Library: The Amplitude library used to send the event
  • Split OS descriptor after : into description column of new table
  • Update example value for referrer in Custom user properties table: this is a broken link for anyone clicking from the docs page
  • Fix link for Amplitude event documentation for Benefits, filtered by Core (currently points to Auth filtered events)
  • Delete (e.g. Littlepay) from Enrollment event names

Additional context

Consider if we really want to link to the app multiple times from our docs. Especially given #1842 that links to the app directly from the landing page at the very top of the docs site.

@thekaveman thekaveman added the documentation [auto] Improvements or additions to documentation label Jan 2, 2024
@machikoyasuda machikoyasuda self-assigned this Jan 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation [auto] Improvements or additions to documentation
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

2 participants