UML diagrams should be put into the respective repositories in an editable format.
|Open||None||T241215 Improve Wikibase lower and mid level documentation|
|Open||None||T75604 [Story] create documentation of php data model|
|Resolved||None||T75606 update documentation of js data model|
|Invalid||daniel||T75603 [Story] update documentation of high-level data model|
|Invalid||None||T100423 [Bug] Remove DataTypes dependency from class diagram|
|Invalid||None||T92365 [Story] Centralize Wikibase documentation process and assign responsibilities|
|Invalid||None||T96679 [Task] Put sources of datamodel diagrams into the respective code repositories|
These should be the most recent versions of the diagrams I compiled. (Entityview diagram is supposed to be work in progress and it does not look like it will be finished.) You probably want to rename the files before uploading.
If you feel the unnecessary need for attribution when uploading, just suppress it; At least, just do not use any full name. Thanks. If something is to be uploaded to commons, I could do that with my account as well.
@Tobi_WMDE_SW Wikimedia allows only a limited set of file formats for upload. We cannot upload MDJ files. We could embed the XML in a wikitext page, but that's super ugly. We can and should upload SVG or PNG renderings of the diagrams, of course.
For now I suggest to put the sources of the high level diagram into the docs/ directory in Wikibase.git. If we end up having a lot of abstract documentation like that, a separate git repo might be justified.
We should however also decide which file format we want to use. MDJ is StartUML's format, which (I assume) is open and documented, but can it be read by other UML software? The "official" exchange formats for UML seem to be UXF and XMI. But I don't know how well supported these are in reality....
Yay for agile documentation!
One concern I do have is that if we bundle a diagram with the code, then it needs to be updated when the code is updated. Not for every commit clearly, but for every release that includes significant changes. So it'd be good if multiple people can do this updating, else we introduce a potential release blocker (of course we could always drop the diagram in such a case, but that is clearly not ideal either).
How do you want to move on with that? The files as they are now can be exported to either PNG, JPEG, SVG or PDF using StarUML. It is not possible to export these to UXF or XMI. If it is a strong requirement to have these files in one of these formats, that AFAIK would mean to redo them. In that case it is currently unclear what priority this has and when there will be free capacities to do this work.
- please either put the mdj files into the respective repositories or specify which of the possible export-formats (PNG, JPEG, SVG, PDF) you want to have.
- if this is not possible and the diagrams need to be redone, then block this task on a new task "Redo UML diagrams in format <desired_format>" and then remove the task from the sprint.
If we can't get UXF or XMI, I suggest to put SVG on commons, and MDJ into git (not sure which repo, though). On the description page of the SVGs, there should be a link to the file in the gerrit repo, and instructions for checking it out and in. Direct modification of the SVG should be avoided. It's annoying though that StarUML would be required for editing.