{"action":"created","issue":{"url":"https://api.github.com/repos/globaleaks/GlobaLeaks/issues/2041","repository_url":"https://api.github.com/repos/globaleaks/GlobaLeaks","labels_url":"https://api.github.com/repos/globaleaks/GlobaLeaks/issues/2041/labels{/name}","comments_url":"https://api.github.com/repos/globaleaks/GlobaLeaks/issues/2041/comments","events_url":"https://api.github.com/repos/globaleaks/GlobaLeaks/issues/2041/events","html_url":"https://github.com/globaleaks/GlobaLeaks/issues/2041","id":247445423,"number":2041,"title":"Include an entity relationship diagram within the documentation","user":{"login":"NSkelsey","id":1095794,"avatar_url":"https://avatars2.githubusercontent.com/u/1095794?v=4","gravatar_id":"","url":"https://api.github.com/users/NSkelsey","html_url":"https://github.com/NSkelsey","followers_url":"https://api.github.com/users/NSkelsey/followers","following_url":"https://api.github.com/users/NSkelsey/following{/other_user}","gists_url":"https://api.github.com/users/NSkelsey/gists{/gist_id}","starred_url":"https://api.github.com/users/NSkelsey/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/NSkelsey/subscriptions","organizations_url":"https://api.github.com/users/NSkelsey/orgs","repos_url":"https://api.github.com/users/NSkelsey/repos","events_url":"https://api.github.com/users/NSkelsey/events{/privacy}","received_events_url":"https://api.github.com/users/NSkelsey/received_events","type":"User","site_admin":false},"labels":[{"id":33588028,"url":"https://api.github.com/repos/globaleaks/GlobaLeaks/labels/C:%20Documentation","name":"C: Documentation","color":"eb6420","default":false},{"id":12818912,"url":"https://api.github.com/repos/globaleaks/GlobaLeaks/labels/T:%20Enhancement","name":"T: Enhancement","color":"207de5","default":false}],"state":"closed","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":2,"created_at":"2017-08-02T16:16:43Z","updated_at":"2017-08-22T14:56:41Z","closed_at":"2017-08-22T14:54:42Z","body":"**Summary**\r\nOur documentation lacks useful information about the internal structure of globaleaks. It would be very nice to have up to date entity relationship diagrams shipped with our documentation. Using the python library [eralchemy](https://pypi.python.org/pypi/ERAlchemy) we could include the generation of schema with the MAKE of the documentation.\r\n\r\n**Manual Steps**\r\n\r\nFollow the following steps to reproduce the graphs by hand:\r\n\r\n```bash\r\n> apt install graphviz-dev\r\n> pip install eralchemy\r\n> eralchemy -i sqlite:///globaleaks/tests/db/populated/glbackend-37.db -o entity-relations.pdf\r\n> touch entity-relations.pdf\r\nentity-relations.pdf: PDF document, version 1.5\r\n```\r\n\r\n**Example output**\r\nFiles generated on 02/08/2017:\r\n- [ER-v2.70.10.pdf](https://github.com/globaleaks/GlobaLeaks/files/1194505/ER-v2.70.10.pdf)\r\n- [ER-v2.67.4-multitenancy-fork.pdf](https://github.com/globaleaks/GlobaLeaks/files/1194509/ER-v2.67.4-multitenancy-fork.pdf)\r\n\r\n**Todo**\r\n\r\n- Validate build process supports custom logic like this\r\n- Implement install of reqiurements.txt\r\n- Implement move of files into proper assets directory\r\n- (Maybe) add annotation to document version/build dates.\r\n"},"comment":{"url":"https://api.github.com/repos/globaleaks/GlobaLeaks/issues/comments/324052715","html_url":"https://github.com/globaleaks/GlobaLeaks/issues/2041#issuecomment-324052715","issue_url":"https://api.github.com/repos/globaleaks/GlobaLeaks/issues/2041","id":324052715,"user":{"login":"fpietrosanti","id":770363,"avatar_url":"https://avatars3.githubusercontent.com/u/770363?v=4","gravatar_id":"","url":"https://api.github.com/users/fpietrosanti","html_url":"https://github.com/fpietrosanti","followers_url":"https://api.github.com/users/fpietrosanti/followers","following_url":"https://api.github.com/users/fpietrosanti/following{/other_user}","gists_url":"https://api.github.com/users/fpietrosanti/gists{/gist_id}","starred_url":"https://api.github.com/users/fpietrosanti/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/fpietrosanti/subscriptions","organizations_url":"https://api.github.com/users/fpietrosanti/orgs","repos_url":"https://api.github.com/users/fpietrosanti/repos","events_url":"https://api.github.com/users/fpietrosanti/events{/privacy}","received_events_url":"https://api.github.com/users/fpietrosanti/received_events","type":"User","site_admin":false},"created_at":"2017-08-22T14:56:41Z","updated_at":"2017-08-22T14:56:41Z","body":"Or make a wiki page or quick reference on the development documentation \n\nSent from mobile\n\n> On 22 Aug 2017, at 16:54, Nick Skelsey <notifications@github.com> wrote:\n> \n> Closed #2041.\n> \n> —\n> You are receiving this because you are subscribed to this thread.\n> Reply to this email directly, view it on GitHub, or mute the thread.\n> \n"}}
{"actor":{"display_login":"fpietrosanti"}}