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(analytics): add table for default user props #1846

Merged
merged 1 commit into from Jan 9, 2024

Conversation

machikoyasuda
Copy link
Member

@machikoyasuda machikoyasuda commented Jan 8, 2024

closes #1841

What this PR does

  1. On first reference, the app is now referred to like this: For people who might think "app" means a mobile application, I use the phrase currently live at https://..... But, I do not link the actual link - because we are trying to discourage "drive-by clicks" that artificially inflate our click-through numbers. (Though remember, if we want to filter out People Who Came To Benefits via the Documentation or any Calitp.org website/social media, we can do that too -- so it's not a huge porblem.)

I thought about linking back to the documentation front page - especially because it has the visual screenshot example, but I thought that would confuse the confused people even more. So I settled on showing a text link without it hyperlinked. If someone is TRULY confused about what the site they are reading documentation about, they can copy and paste that link and go there themselves.

image

On second and further references, I remove links entirely.
image

And lastly, for user property example values - again - I do NOT link to the app itself.
image

The point here isn't for someone to go to the Help page. It's to serve as an example for someone who wants to know what a "URL that the event came from" could like.

cc @thekaveman @indexing - Check it out live on the preview site here: https://benefits-1846--cal-itp-previews.netlify.app/product-and-design/analytics/

@machikoyasuda machikoyasuda requested a review from a team as a code owner January 8, 2024 23:49
@github-actions github-actions bot added the documentation [auto] Improvements or additions to documentation label Jan 8, 2024
Copy link

github-actions bot commented Jan 8, 2024

Coverage report

This PR does not seem to contain any modification to coverable code.

Copy link

github-actions bot commented Jan 8, 2024

Preview url: https://benefits-1846--cal-itp-previews.netlify.app

@machikoyasuda
Copy link
Member Author

@machikoyasuda machikoyasuda self-assigned this Jan 8, 2024
@thekaveman
Copy link
Member

@thekaveman

Does this link go to the Core filtered page for you? It does for me. So I didn't change it.

Yep @machikoyasuda you are right, it works for me too (both in the original site and this new version) -- so I'm not sure what I was seeing last week. Sorry about that!

Copy link
Member

@thekaveman thekaveman left a comment

Choose a reason for hiding this comment

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

These changes are all great and LGTM, thank you!

@machikoyasuda machikoyasuda merged commit 5b84649 into dev Jan 9, 2024
12 checks passed
@machikoyasuda machikoyasuda deleted the docs/1841-analytics-edits branch January 9, 2024 00:35
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
None yet
Development

Successfully merging this pull request may close these issues.

Analytics docs clean up
2 participants