techdocs icon indicating copy to clipboard operation
techdocs copied to clipboard

Suggested doc: add recommendation for analytics page

Open a-mccarthy opened this issue 3 years ago • 5 comments

This idea came out of a conversation with @nate-double-u around analytics for project sites. Analytics provide valuable information around content usage and can help a community prioritize pages to focus energy on across many levels of docs work, including release docs, localization work, etc.

Some possible recommendations ideas

  • how to get analytics information. All CNCF project teams should have access to site analytics though Netlify Analytics. This feature must be enabled on each site
  • make analytic information available to your community. Create a analytics page on your site, for example see the Kubernetes Viewing Analytics page. Or present information regularly at community meetings

a-mccarthy avatar Mar 31 '22 13:03 a-mccarthy

@nate-double-u hopefully this captures what we were chatting about yesterday!

a-mccarthy avatar Mar 31 '22 13:03 a-mccarthy

  • Related: #108

chalin avatar Apr 26 '22 16:04 chalin

We might also want to recommend the following approach:

  • https://github.com/open-telemetry/opentelemetry.io/issues/1626

chalin avatar Aug 17 '22 22:08 chalin

I've been working on updating the kubernetes dashboard to use GA4 and I was able to make a more "blank" template in looker studio. https://lookerstudio.google.com/u/0/reporting/df34ae1f-5ce4-452f-9f3d-87dc50273dd2/page/4VDGB/edit

The idea is that if a project wants to have a dashboard of their analytics available they can copy this dashboard template and connect to their ga4 account as a data source. Hopefully its as "simple" as that, but i dont have any way to test this b/c i dont have access to any other ga4 account :) (the dashboard is connected to the Kubernetes account so the charts work)

Some thoughts

  • It assumes that a projects ga4 account already exists and is set up similar to the kubernetes account
  • page 4 of the dashboard is a "How to set up a dashboard" docs page, but is in need of some updates specifically
    • the permissions section needs to be updated to be more generic (but i need another account to test to see how to set it up properly)
    • make sure the set up section is completed, needs another account to step through the process with to make sure the steps are all there.

Not sure how much of a need other projects have for something like this, but it was pretty straightforward to create a first pass template, so I figured i'd share it and see if there is any interest in refining it :)

a-mccarthy avatar Feb 15 '24 15:02 a-mccarthy

Wow, this is great! Thanks for having persisted in getting this to work.

I'll give it a spin for the OTel site if maintainers are open to it:

  • https://github.com/open-telemetry/opentelemetry.io/issues/4017

chalin avatar Feb 16 '24 22:02 chalin