We need to create a mid level documentation of our php data model.
Description
Details
- Reference
- bz73604
Status | Subtype | Assigned | Task | ||
---|---|---|---|---|---|
Open | None | T241215 Improve Wikibase lower and mid level documentation | |||
Open | None | T75604 [Story] create documentation of php data model | |||
Invalid | daniel | T75603 [Story] update documentation of high-level data model | |||
Invalid | None | T96587 [Task] The data model specification should cover the notion of alias IDs (redirects) | |||
Invalid | None | T98598 [Story] Overhaul documentation of data values | |||
Invalid | None | T96679 [Task] Put sources of datamodel diagrams into the respective code repositories | |||
Invalid | None | T96681 [Task] Review and polish new version of data model primer |
Event Timeline
Why is this under "Repo"?
The reality is in the implementation of the PHP DataModel. And we don't high level documentation for it (yet) that could get out of date. So I do not understand what this is about.
While trying to compile some high-level documentation, I figured out that that does not make much sense without some proper visualization. Consequently, I started drawing out the data model as that is the component where basically all of the terms "derive" from. The original intention was to not go into too much of detail -- then again, how to avoid? Working on high-level documentation requires having an overview first. Currently there is no way to get the complete picture without crawling through all the code and doxygen diagrams do not really provide useful.
For high-level documentation (i.e. T75603), the diagram should be stripped down considerably. Nonetheless, overall documentation would benefit a lot from having and maintaining that detailed view on the core component.
Please feel free to review the diagram, I would really like to get the picture right:
As the PHP data model 2.6 has been released and no additional changes that would affect the diagram have been made since the diagram's last version, I propose embedding it on https://github.com/wmde/WikibaseDataModel just like it is done on https://github.com/wmde/WikibaseDataModelJavaScript as long as there are no objections against the diagram content. (I assume there are none as there was enough time to review.)
Since the generated code documentation is already on http://wbdoc.wmflabs.org/, I propose closing this ticket after embedding the diagram. (I doubt it would make sense to create another diagram for differs and patchers.)
@thiemowmde @JeroenDeDauw @daniel @JanZerebecki @aude
Do you have comments/suggestions on the content of the diagram and do you agree embedding it in the repository?
Having such a diagram would be nice.
Something along the lines of what is on these slides as well: http://jeroendedauw.github.io/slides/smwcon/2014fall/wikibase/#/3/1 Since this is conceptual, maintenance for that should be very low
What I'd really like to have is such a simple conceptual overview together with some pointers on where to find code dealing with each part of it.
Why merge a story with a task if that would be the correct thing to do either the definition and differentiation of story and task is inconsistent or one of them is incorrectly labeled?