Download & Extend

Architecture documentation of Party

Project:Party
Version:7.x-1.x-dev
Component:Documentation
Category:support request
Priority:normal
Assigned:yanniboi
Status:active

Issue Summary

Reading through lots of tickets and discussions on the CRM-API group and in this issue queue I came up with a simple ER-style graph that sketches the current architecture of the party-module. I'm sure it's still incomplete but I think it already could help someone else. I'd also like to create a new corrected versions of it once there is some feedback.

graph of the party architecture

AttachmentSizeStatusTest resultOperations
party.dot_.png62.72 KBIgnored: Check issue status.NoneNone

Comments

#1

This is awesome thanks!!! I think we'll look into it in more detail at our sprint in edinburgh tommorrow :D

#2

Have any modifications/improvements been made to this since Edinburgh?

#3

Party type has gone.

#4

Party Pieces have gone. This picture is so awesome. Wonder if Yanniboi you can try and make a new version of this picture that is up to date?

#5

> Party Pieces have gone

They haven't.

But they're just about display -- not part of the data architecture, so can be left off this diagram.

#6

This looks like it was made in dia, so it could be versioned as xml ;)

#7

In which case, how about we put it up on github? Or actually, just as easy in a sandbox here.

#8

Assigned to:Anonymous» yanniboi

> Wonder if Yanniboi you can try and make a new version of this picture that is up to date?

Ok, Il take a crack at it!

#9

I've started a site builder section of our docs here: http://drupal.org/node/1669650. Feel free to add to it :)

#10

I've begun a lucidchart document here:

https://www.lucidchart.com/documents/view/4676-9be0-5006beb5-9cb9-71d30a...

Party Module ERD - Lucidchart

We can edit this document in a realtime collaborative environment. All you need is a google account or something of the like. Folks can freely edit this document as long as we keep the total components under 50 items (not including connecting lines). I think that using a collaboratively edited ERD will be incredibly helpful in ensuring folks who are contributing to development understand the architecture and desired behaviour in one general, visual overview. That said, I don't know very much about ERD!

If anyone wants an invite to collaborate on this document, let me know! I can send an invite or add folks as collaborators

AttachmentSizeStatusTest resultOperations
PartyModuleArchitecture-1.png56.06 KBIgnored: Check issue status.NoneNone

#11

Thanks for putting up a new version of this. I was on vacation for the last 3 weeks so I couldn't take part in the discussion.

The original intend for this diagram was to show _all_ concepts that are/were used (anywhere) in party. If you find some bit of info on d.o or in the code you should be able to go to this diagram and get a grasp on what's meant - even if there is no 1:1 representation in the DB-model.

#12

Indeed, it's been very helpful! I basically just copied what you had made in LucidChart so we could open it up to collaboration - the idea is that it could serve as a working draft specification for the ER structure of Party. We plan on posting this on the party site.

#13

I've posted an editable version of my diagram on https://gist.github.com/3205540 .