-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
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
APIv3: add analytics
field to Project
object
#10239
Conversation
New `analytics` field that exposes: - the Google code if the project has it configured - whether or not the global Google/Plausible Read the Docs analytics is enabled This field is going to be useful for the new "Analytics Addon". Related #10216
We are deprecating the GA analytics in #9530, so may not make sense to expose this here? |
We need to decide what to do with this field, tho. We have ~1900 projects disabling Read the Docs analytics. I think I'm fine removing this config and always enforce our own analytics to projects, https://docs.readthedocs.io/en/stable/analytics.html#disabling-google-analytics-on-your-project -- I'm not sure if it adds too much value to our platform 🤷🏼 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The change is pretty straightforward. And the dictionary structure with google
and readthedocs
is great!
There are some weird test failures, but maybe merging main can fix that?
@humitos You mean that it's better to expose it in the API and take a separate decision about deprecating / keeping it? I think it's fine - actually, it's not bad that someone would want to use this part of the API, just means that it's relevant. |
I'm saying we should not merge this PR yet. We need to define how people will/if decide whether or not they want us to include our own analytics in their docs. |
Okay, I'm confused about how a change that exposes a field in the API contributes to an actual change in configuration and documentation rendering. |
I'm closing this PR because we are moving forward with the plan from #9530 (comment) |
New
analytics
field that exposes:This field is going to be useful for the new "Analytics Addon".
Related #10216