There is no inline documentation or note in the README in the PageImages extension about how PageImages are populated and what developers should be wary of when working with this codebase. Let's add some to protect against incidents such as https://wikitech.wikimedia.org/wiki/Incident_documentation/20161202-20161201-PageImages
Description
Details
Subject | Repo | Branch | Lines +/- | |
---|---|---|---|---|
Document page property names | mediawiki/extensions/PageImages | master | +9 -1 |
Status | Subtype | Assigned | Task | ||
---|---|---|---|---|---|
Resolved | ovasileva | T146758 Inform community on changes to images API | |||
Resolved | None | T152239 [2hrs] PageImages code should have documentation warning developers about caching implications |
Event Timeline
Change 333805 had a related patch set uploaded (by Jdlrobson):
Document page property names
It seemed an inline comment was most appropriate here.
We should document the config variables in a readme and how they behave but I don't see how this would help protect us against license issues like that in the incident since there is no config switch that impacts it.
This task is about documenting caching implications gotchas around the licensing-related config variables and not necessarily licensing issues themselves. A note in the README seems appropriate.
There are no licensing related config; that's my point. The inline comment is most appropriate in my opinion then a out of context note in a read me... Which is done.
^ Thinking about my assumptions: am I correct in assuming that we announced the new default on a mailing list?
I couldn't find an announcement, though this is likely not finding the right Google incantation. The most recent changes have been discussed a number of times on reading-wmf and well documented on mediawiki.org.
I think this task can be considered done since the new behaviour is the default and it's not flagged.