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

Single analytics file for all builders #3896

Merged
merged 1 commit into from Apr 5, 2018

Conversation

Projects
None yet
2 participants
@davidfischer
Contributor

davidfischer commented Apr 3, 2018

This pull request breaks out the analytics file readthedocs-dynamic-include.js which is typically created with each docs build into a separate file which will live at https://media.readthedocs.org/javascript/readthedocs-analytics.js.

  • This PR only removes readthedocs-dynamic-include.js only for mkdocs. Referencing the same analytics file will be done for sphinx builds as well but that change will be in https://github.com/rtfd/readthedocs-sphinx-ext (probably an update on rtfd/readthedocs-sphinx-ext#33)
  • This PR sets the groundwork for both mkdocs and sphinx to use the same analytics file rather than having any change to analytics require simultaneous corresponding changes across multiple repos.
  • If we ever swap out Google Analytics, that could be done server side and we would immediately see analytics with an alternative system rather than waiting for projects to be rebuilt.
  • This PR also puts some of my (our?) thoughts on Google Analytics to paper as this isn't an uncommon question we get from privacy conscious users.
  • This will result in a minor performance improvement because multiple project docs will use the same readthedocs-analytics.js file which is cached (albeit only for a week with our current settings).

@davidfischer davidfischer requested a review from ericholscher Apr 3, 2018

@ericholscher

Think this is a great direction. Having the ability to change this stuff dynamically in the future is a good first step towards another approach when we choose to move forward with something else.

// Read the Docs instructs Google to anonymize IPs sent to them before they are stored (see below).
// We are always exploring our options with respect to analytics and if you would like
// to discuss further, feel free to open an issue on github.

This comment has been minimized.

@ericholscher

ericholscher Apr 4, 2018

Member

👍

@ericholscher ericholscher merged commit c83b17a into rtfd:master Apr 5, 2018

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment