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 #1818

Merged
merged 4 commits into from Dec 13, 2023
Merged

Docs: Analytics #1818

merged 4 commits into from Dec 13, 2023

Conversation

machikoyasuda
Copy link
Member

@machikoyasuda machikoyasuda commented Dec 11, 2023

closes #953

What this PR does

image image image image image

@github-actions github-actions bot added the documentation [auto] Improvements or additions to documentation label Dec 11, 2023
Copy link

Coverage report

The coverage rate went from 90.87% to 90.87% ➡️
The branch rate is 85%.

None of the new lines are part of the tested code. Therefore, there is no coverage data about them.

@machikoyasuda machikoyasuda self-assigned this Dec 11, 2023
@machikoyasuda machikoyasuda marked this pull request as ready for review December 12, 2023 18:54
@machikoyasuda machikoyasuda requested a review from a team as a code owner December 12, 2023 18:54
@machikoyasuda
Copy link
Member Author

Ready for review @indexing @angela-tran

@indexing
Copy link
Member

@machikoyasuda Everywhere we mention the "Cal-ITP Benefits application" in the Analytics doc, I proposed we make the text link to https://benefits.calitp.org so readers can easily correlate the documentation to the product.

Copy link
Member

@angela-tran angela-tran left a comment

Choose a reason for hiding this comment

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

This looks good to me @machikoyasuda !

@machikoyasuda machikoyasuda merged commit 2a3b8d0 into dev Dec 13, 2023
8 checks passed
@machikoyasuda machikoyasuda deleted the docs/953-analytics branch December 13, 2023 19:38
@thekaveman
Copy link
Member

thekaveman commented Jan 2, 2024

@machikoyasuda Everywhere we mention the "Cal-ITP Benefits application" in the Analytics doc, I proposed we make the text link to https://benefits.calitp.org so readers can easily correlate the documentation to the product.

@indexing @machikoyasuda Let's have another think about this, I disagree that we need to link to the app all over our docs pages. By and large we don't expect the audience of the docs to overlap much with the real audience of the app, and we don't need/want to inflate any analytics with drive-bys.

We certainly want to link to the app from e.g. the docs homepage. I just don't think we need to make every instance of the phrase link to it.

@thekaveman thekaveman mentioned this pull request Jan 2, 2024
11 tasks
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.

Add page/section describing Analytics
4 participants