{"action":"created","comment":{"url":"https://api.github.com/repos/aldryn/aldryn-reversion/pulls/comments/38304412","id":38304412,"diff_hunk":"@@ -0,0 +1,124 @@\n+##############################\n+Apply Aldryn Reversion support\n+##############################\n+\n+Using Aldryn Reversion in your project is fairly strightforward.\n+\n+There are two key steps required:\n+\n+* applying a registration decorator to your model\n+* adding a mixin to the model's admin class definition\n+\n+\n+******************\n+Model registration\n+******************\n+\n+For the model, add ``@version_controlled_content`` as a decorator::\n+\n+    from aldryn-reversion.core import version_controlled_content\n+\n+    @version_controlled_content\n+    class MyModel(models.Model):\n+        ...\n+\n+If your model has foreign key relations, use the ``follow`` property from\n+``django-reversions`` when applying the decorator::\n+\n+    @version_controlled_content(follow=['my_fk_field'])\n+    class MyModel(models.Model):\n+        my_fk_field = models.ForeignKey(OtherModel)\n+        ...\n+\n+\n+This also add the related objects as version-controlled content.","path":"docs/introduction/configuration.rst","position":34,"original_position":34,"commit_id":"a47db0451e269bbb0f4c0a976ad7f0c3f51c4661","original_commit_id":"a47db0451e269bbb0f4c0a976ad7f0c3f51c4661","user":{"login":"intellectronica","id":46264,"avatar_url":"https://avatars.githubusercontent.com/u/46264?v=3","gravatar_id":"","url":"https://api.github.com/users/intellectronica","html_url":"https://github.com/intellectronica","followers_url":"https://api.github.com/users/intellectronica/followers","following_url":"https://api.github.com/users/intellectronica/following{/other_user}","gists_url":"https://api.github.com/users/intellectronica/gists{/gist_id}","starred_url":"https://api.github.com/users/intellectronica/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/intellectronica/subscriptions","organizations_url":"https://api.github.com/users/intellectronica/orgs","repos_url":"https://api.github.com/users/intellectronica/repos","events_url":"https://api.github.com/users/intellectronica/events{/privacy}","received_events_url":"https://api.github.com/users/intellectronica/received_events","type":"User","site_admin":false},"body":"\"This also adds the related\"","created_at":"2015-08-31T11:48:02Z","updated_at":"2015-08-31T11:48:02Z","html_url":"https://github.com/aldryn/aldryn-reversion/pull/21#discussion_r38304412","pull_request_url":"https://api.github.com/repos/aldryn/aldryn-reversion/pulls/21","_links":{"self":{"href":"https://api.github.com/repos/aldryn/aldryn-reversion/pulls/comments/38304412"},"html":{"href":"https://github.com/aldryn/aldryn-reversion/pull/21#discussion_r38304412"},"pull_request":{"href":"https://api.github.com/repos/aldryn/aldryn-reversion/pulls/21"}}},"pull_request":{"url":"https://api.github.com/repos/aldryn/aldryn-reversion/pulls/21","id":43306245,"html_url":"https://github.com/aldryn/aldryn-reversion/pull/21","diff_url":"https://github.com/aldryn/aldryn-reversion/pull/21.diff","patch_url":"https://github.com/aldryn/aldryn-reversion/pull/21.patch","issue_url":"https://api.github.com/repos/aldryn/aldryn-reversion/issues/21","number":21,"state":"open","locked":false,"title":"Documentation: setup and first steps.","user":{"login":"cyberstar","id":744434,"avatar_url":"https://avatars.githubusercontent.com/u/744434?v=3","gravatar_id":"","url":"https://api.github.com/users/cyberstar","html_url":"https://github.com/cyberstar","followers_url":"https://api.github.com/users/cyberstar/followers","following_url":"https://api.github.com/users/cyberstar/following{/other_user}","gists_url":"https://api.github.com/users/cyberstar/gists{/gist_id}","starred_url":"https://api.github.com/users/cyberstar/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/cyberstar/subscriptions","organizations_url":"https://api.github.com/users/cyberstar/orgs","repos_url":"https://api.github.com/users/cyberstar/repos","events_url":"https://api.github.com/users/cyberstar/events{/privacy}","received_events_url":"https://api.github.com/users/cyberstar/received_events","type":"User","site_admin":false},"body":"Documentation setup and initial information on how to use and known issues.\r\nChanges into readme to extract info into documentation.\r\n\r\nMake files are auto generated.","created_at":"2015-08-25T16:20:31Z","updated_at":"2015-08-31T11:48:02Z","closed_at":null,"merged_at":null,"merge_commit_sha":"0396be0de0e9de42474923a396ae42911f917fb3","assignee":null,"milestone":null,"commits_url":"https://api.github.com/repos/aldryn/aldryn-reversion/pulls/21/commits","review_comments_url":"https://api.github.com/repos/aldryn/aldryn-reversion/pulls/21/comments","review_comment_url":"https://api.github.com/repos/aldryn/aldryn-reversion/pulls/comments{/number}","comments_url":"https://api.github.com/repos/aldryn/aldryn-reversion/issues/21/comments","statuses_url":"https://api.github.com/repos/aldryn/aldryn-reversion/statuses/a47db0451e269bbb0f4c0a976ad7f0c3f51c4661","head":{"label":"aldryn:feature/documentation","ref":"feature/documentation","sha":"a47db0451e269bbb0f4c0a976ad7f0c3f51c4661","user":{"login":"aldryn","id":4201738,"avatar_url":"https://avatars.githubusercontent.com/u/4201738?v=3","gravatar_id":"","url":"https://api.github.com/users/aldryn","html_url":"https://github.com/aldryn","followers_url":"https://api.github.com/users/aldryn/followers","following_url":"https://api.github.com/users/aldryn/following{/other_user}","gists_url":"https://api.github.com/users/aldryn/gists{/gist_id}","starred_url":"https://api.github.com/users/aldryn/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/aldryn/subscriptions","organizations_url":"https://api.github.com/users/aldryn/orgs","repos_url":"https://api.github.com/users/aldryn/repos","events_url":"https://api.github.com/users/aldryn/events{/privacy}","received_events_url":"https://api.github.com/users/aldryn/received_events","type":"Organization","site_admin":false},"repo":{"id":31263598,"name":"aldryn-reversion","full_name":"aldryn/aldryn-reversion","owner":{"login":"aldryn","id":4201738,"avatar_url":"https://avatars.githubusercontent.com/u/4201738?v=3","gravatar_id":"","url":"https://api.github.com/users/aldryn","html_url":"https://github.com/aldryn","followers_url":"https://api.github.com/users/aldryn/followers","following_url":"https://api.github.com/users/aldryn/following{/other_user}","gists_url":"https://api.github.com/users/aldryn/gists{/gist_id}","starred_url":"https://api.github.com/users/aldryn/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/aldryn/subscriptions","organizations_url":"https://api.github.com/users/aldryn/orgs","repos_url":"https://api.github.com/users/aldryn/repos","events_url":"https://api.github.com/users/aldryn/events{/privacy}","received_events_url":"https://api.github.com/users/aldryn/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/aldryn/aldryn-reversion","description":"","fork":false,"url":"https://api.github.com/repos/aldryn/aldryn-reversion","forks_url":"https://api.github.com/repos/aldryn/aldryn-reversion/forks","keys_url":"https://api.github.com/repos/aldryn/aldryn-reversion/keys{/key_id}","collaborators_url":"https://api.github.com/repos/aldryn/aldryn-reversion/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/aldryn/aldryn-reversion/teams","hooks_url":"https://api.github.com/repos/aldryn/aldryn-reversion/hooks","issue_events_url":"https://api.github.com/repos/aldryn/aldryn-reversion/issues/events{/number}","events_url":"https://api.github.com/repos/aldryn/aldryn-reversion/events","assignees_url":"https://api.github.com/repos/aldryn/aldryn-reversion/assignees{/user}","branches_url":"https://api.github.com/repos/aldryn/aldryn-reversion/branches{/branch}","tags_url":"https://api.github.com/repos/aldryn/aldryn-reversion/tags","blobs_url":"https://api.github.com/repos/aldryn/aldryn-reversion/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/aldryn/aldryn-reversion/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/aldryn/aldryn-reversion/git/refs{/sha}","trees_url":"https://api.github.com/repos/aldryn/aldryn-reversion/git/trees{/sha}","statuses_url":"https://api.github.com/repos/aldryn/aldryn-reversion/statuses/{sha}","languages_url":"https://api.github.com/repos/aldryn/aldryn-reversion/languages","stargazers_url":"https://api.github.com/repos/aldryn/aldryn-reversion/stargazers","contributors_url":"https://api.github.com/repos/aldryn/aldryn-reversion/contributors","subscribers_url":"https://api.github.com/repos/aldryn/aldryn-reversion/subscribers","subscription_url":"https://api.github.com/repos/aldryn/aldryn-reversion/subscription","commits_url":"https://api.github.com/repos/aldryn/aldryn-reversion/commits{/sha}","git_commits_url":"https://api.github.com/repos/aldryn/aldryn-reversion/git/commits{/sha}","comments_url":"https://api.github.com/repos/aldryn/aldryn-reversion/comments{/number}","issue_comment_url":"https://api.github.com/repos/aldryn/aldryn-reversion/issues/comments{/number}","contents_url":"https://api.github.com/repos/aldryn/aldryn-reversion/contents/{+path}","compare_url":"https://api.github.com/repos/aldryn/aldryn-reversion/compare/{base}...{head}","merges_url":"https://api.github.com/repos/aldryn/aldryn-reversion/merges","archive_url":"https://api.github.com/repos/aldryn/aldryn-reversion/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/aldryn/aldryn-reversion/downloads","issues_url":"https://api.github.com/repos/aldryn/aldryn-reversion/issues{/number}","pulls_url":"https://api.github.com/repos/aldryn/aldryn-reversion/pulls{/number}","milestones_url":"https://api.github.com/repos/aldryn/aldryn-reversion/milestones{/number}","notifications_url":"https://api.github.com/repos/aldryn/aldryn-reversion/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/aldryn/aldryn-reversion/labels{/name}","releases_url":"https://api.github.com/repos/aldryn/aldryn-reversion/releases{/id}","created_at":"2015-02-24T14:26:03Z","updated_at":"2015-08-21T12:48:00Z","pushed_at":"2015-08-31T10:10:38Z","git_url":"git://github.com/aldryn/aldryn-reversion.git","ssh_url":"git@github.com:aldryn/aldryn-reversion.git","clone_url":"https://github.com/aldryn/aldryn-reversion.git","svn_url":"https://github.com/aldryn/aldryn-reversion","homepage":null,"size":448,"stargazers_count":0,"watchers_count":0,"language":"Python","has_issues":true,"has_downloads":true,"has_wiki":false,"has_pages":false,"forks_count":0,"mirror_url":null,"open_issues_count":5,"forks":0,"open_issues":5,"watchers":0,"default_branch":"master"}},"base":{"label":"aldryn:master","ref":"master","sha":"e7b54d7233d497d8587ae1c50ddd0004f584203c","user":{"login":"aldryn","id":4201738,"avatar_url":"https://avatars.githubusercontent.com/u/4201738?v=3","gravatar_id":"","url":"https://api.github.com/users/aldryn","html_url":"https://github.com/aldryn","followers_url":"https://api.github.com/users/aldryn/followers","following_url":"https://api.github.com/users/aldryn/following{/other_user}","gists_url":"https://api.github.com/users/aldryn/gists{/gist_id}","starred_url":"https://api.github.com/users/aldryn/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/aldryn/subscriptions","organizations_url":"https://api.github.com/users/aldryn/orgs","repos_url":"https://api.github.com/users/aldryn/repos","events_url":"https://api.github.com/users/aldryn/events{/privacy}","received_events_url":"https://api.github.com/users/aldryn/received_events","type":"Organization","site_admin":false},"repo":{"id":31263598,"name":"aldryn-reversion","full_name":"aldryn/aldryn-reversion","owner":{"login":"aldryn","id":4201738,"avatar_url":"https://avatars.githubusercontent.com/u/4201738?v=3","gravatar_id":"","url":"https://api.github.com/users/aldryn","html_url":"https://github.com/aldryn","followers_url":"https://api.github.com/users/aldryn/followers","following_url":"https://api.github.com/users/aldryn/following{/other_user}","gists_url":"https://api.github.com/users/aldryn/gists{/gist_id}","starred_url":"https://api.github.com/users/aldryn/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/aldryn/subscriptions","organizations_url":"https://api.github.com/users/aldryn/orgs","repos_url":"https://api.github.com/users/aldryn/repos","events_url":"https://api.github.com/users/aldryn/events{/privacy}","received_events_url":"https://api.github.com/users/aldryn/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/aldryn/aldryn-reversion","description":"","fork":false,"url":"https://api.github.com/repos/aldryn/aldryn-reversion","forks_url":"https://api.github.com/repos/aldryn/aldryn-reversion/forks","keys_url":"https://api.github.com/repos/aldryn/aldryn-reversion/keys{/key_id}","collaborators_url":"https://api.github.com/repos/aldryn/aldryn-reversion/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/aldryn/aldryn-reversion/teams","hooks_url":"https://api.github.com/repos/aldryn/aldryn-reversion/hooks","issue_events_url":"https://api.github.com/repos/aldryn/aldryn-reversion/issues/events{/number}","events_url":"https://api.github.com/repos/aldryn/aldryn-reversion/events","assignees_url":"https://api.github.com/repos/aldryn/aldryn-reversion/assignees{/user}","branches_url":"https://api.github.com/repos/aldryn/aldryn-reversion/branches{/branch}","tags_url":"https://api.github.com/repos/aldryn/aldryn-reversion/tags","blobs_url":"https://api.github.com/repos/aldryn/aldryn-reversion/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/aldryn/aldryn-reversion/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/aldryn/aldryn-reversion/git/refs{/sha}","trees_url":"https://api.github.com/repos/aldryn/aldryn-reversion/git/trees{/sha}","statuses_url":"https://api.github.com/repos/aldryn/aldryn-reversion/statuses/{sha}","languages_url":"https://api.github.com/repos/aldryn/aldryn-reversion/languages","stargazers_url":"https://api.github.com/repos/aldryn/aldryn-reversion/stargazers","contributors_url":"https://api.github.com/repos/aldryn/aldryn-reversion/contributors","subscribers_url":"https://api.github.com/repos/aldryn/aldryn-reversion/subscribers","subscription_url":"https://api.github.com/repos/aldryn/aldryn-reversion/subscription","commits_url":"https://api.github.com/repos/aldryn/aldryn-reversion/commits{/sha}","git_commits_url":"https://api.github.com/repos/aldryn/aldryn-reversion/git/commits{/sha}","comments_url":"https://api.github.com/repos/aldryn/aldryn-reversion/comments{/number}","issue_comment_url":"https://api.github.com/repos/aldryn/aldryn-reversion/issues/comments{/number}","contents_url":"https://api.github.com/repos/aldryn/aldryn-reversion/contents/{+path}","compare_url":"https://api.github.com/repos/aldryn/aldryn-reversion/compare/{base}...{head}","merges_url":"https://api.github.com/repos/aldryn/aldryn-reversion/merges","archive_url":"https://api.github.com/repos/aldryn/aldryn-reversion/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/aldryn/aldryn-reversion/downloads","issues_url":"https://api.github.com/repos/aldryn/aldryn-reversion/issues{/number}","pulls_url":"https://api.github.com/repos/aldryn/aldryn-reversion/pulls{/number}","milestones_url":"https://api.github.com/repos/aldryn/aldryn-reversion/milestones{/number}","notifications_url":"https://api.github.com/repos/aldryn/aldryn-reversion/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/aldryn/aldryn-reversion/labels{/name}","releases_url":"https://api.github.com/repos/aldryn/aldryn-reversion/releases{/id}","created_at":"2015-02-24T14:26:03Z","updated_at":"2015-08-21T12:48:00Z","pushed_at":"2015-08-31T10:10:38Z","git_url":"git://github.com/aldryn/aldryn-reversion.git","ssh_url":"git@github.com:aldryn/aldryn-reversion.git","clone_url":"https://github.com/aldryn/aldryn-reversion.git","svn_url":"https://github.com/aldryn/aldryn-reversion","homepage":null,"size":448,"stargazers_count":0,"watchers_count":0,"language":"Python","has_issues":true,"has_downloads":true,"has_wiki":false,"has_pages":false,"forks_count":0,"mirror_url":null,"open_issues_count":5,"forks":0,"open_issues":5,"watchers":0,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/aldryn/aldryn-reversion/pulls/21"},"html":{"href":"https://github.com/aldryn/aldryn-reversion/pull/21"},"issue":{"href":"https://api.github.com/repos/aldryn/aldryn-reversion/issues/21"},"comments":{"href":"https://api.github.com/repos/aldryn/aldryn-reversion/issues/21/comments"},"review_comments":{"href":"https://api.github.com/repos/aldryn/aldryn-reversion/pulls/21/comments"},"review_comment":{"href":"https://api.github.com/repos/aldryn/aldryn-reversion/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/aldryn/aldryn-reversion/pulls/21/commits"},"statuses":{"href":"https://api.github.com/repos/aldryn/aldryn-reversion/statuses/a47db0451e269bbb0f4c0a976ad7f0c3f51c4661"}}}}