matomo-org/matomo

New FAQ: How do I force my website visitors browsers to download the recently updated piwik.js?

Open

#9,619 opened on Jan 22, 2016

View on GitHub
 (11 comments) (0 reactions) (0 assignees)PHP (21,513 stars) (2,847 forks)batch import
Help wantedc: Website matomo.org

Description

Since sometimes changes in piwik's js is nessary (fixes and optimizations) one should made it possible to bring these changes to every visitor especially also to returning visitors as soon as possible (asap = instantly on availibility). At this time caching of visitor's browser slows usage of new version down e.g. https://github.com/piwik/piwik/issues/9607#issuecomment-173673850

The problem is that this file is often chached by the browser and reused for some time.

One solution can be an intelligent versioning of this file / the file hirachie construct around. Everytime there is a change, a recognizable new version is provided and with this loaded and used by the browser.

Some general thoughts about this can be found here https://stackoverflow.com/questions/8224736/javascript-versioning-to-avoid-caching-difference-in-these-practices

Contributor guide

Tech stack
javascript
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
basic understanding of browser caching
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
This issue requests adding a FAQ entry explaining how to force browser cache refresh for piwik.js after updates. The discussion references a Stack Overflow link and a related issue #9607. A contributor should create a new FAQ page or section in the Matomo documentation covering cache busting techniques (e.g., version query string). The existing piwik.js file path and caching behavior should be documented. No linked PR or maintainer response clarifies exact desired format, so the contributor should propose a clear, concise answer.
New FAQ: How do I force my website visitors browsers to download the recently updated piwik.js? · matomo-org/matomo#9619 | Good First Issue