Page MenuHomePhabricator

Add section to config documentation about risks of using local properties when federation is enabled
Closed, ResolvedPublic1 Estimated Story Points

Description

The findings from investigation https://phabricator.wikimedia.org/T255404 should be added to the documentation for federated properties so that users understand what issues they might encounter when enabling federated properties in a Wikibase that already contains properties, or if they "turn off" federated properties.

Event Timeline

toan removed toan as the assignee of this task.Jul 3 2020, 2:29 PM
toan added a subscriber: toan.

Change 609757 had a related patch set uploaded (by Tobias Andersson; owner: Tobias Andersson):
[mediawiki/extensions/Wikibase@master] FP: Add section about mixing local/federated props

https://gerrit.wikimedia.org/r/609757

Change 609757 merged by jenkins-bot:
[mediawiki/extensions/Wikibase@master] FP: Add section about mixing local/federated props

https://gerrit.wikimedia.org/r/609757

Addshore triaged this task as Medium priority.Jul 8 2020, 10:35 AM

Looks great, @toan! I've made some minor changes and added another sentence to the first part for clarity. See below for my suggested text.

I would also vote we remove the text that says turning off the feature will result in fed props displaying as "the local property with the corresponding identifier" as I worry this could be interpreted as there being some local properties created by the act of disabling the feature. Just thinking of the most likely scenario, which is that someone enables federation on an empty WB, adds a bunch of statements, then disables the feature -- its unlikely they'd have any local props at that point. Let me know if you disagree :)

"In the current implementation, Federated Properties cannot be used in combination with local properties. This means enabling the feature on a Wikibase instance that already contains local properties is not supported. As there is currently no distinction between the two different kinds of properties, using local properties when federation is enabled will either cause them to display as a deleted, or as the property with the same entity ID on the federation source Wiki.

For the same reason, enabling Federated Properties and then turning off the feature is not supported once any statements have been added. Doing so will result in those properties displaying as deleted properties."

Change 610862 had a related patch set uploaded (by Tobias Andersson; owner: Tobias Andersson):
[mediawiki/extensions/Wikibase@master] FP: Update documentation known issues section

https://gerrit.wikimedia.org/r/610862

Change 610862 merged by jenkins-bot:
[mediawiki/extensions/Wikibase@master] FP: Update documentation known issues section

https://gerrit.wikimedia.org/r/610862

Addshore added a subscriber: Addshore.

Resolved as it's in the Done column at the end of sprint 3 (start of sprint 4)