{"action":"created","issue":{"url":"https://api.github.com/repos/airblade/paper_trail/issues/854","repository_url":"https://api.github.com/repos/airblade/paper_trail","labels_url":"https://api.github.com/repos/airblade/paper_trail/issues/854/labels{/name}","comments_url":"https://api.github.com/repos/airblade/paper_trail/issues/854/comments","events_url":"https://api.github.com/repos/airblade/paper_trail/issues/854/events","html_url":"https://github.com/airblade/paper_trail/pull/854","id":173091877,"number":854,"title":"Generate an initializer with `track_associations`,  improve docs","user":{"login":"naw","id":8030877,"avatar_url":"https://avatars.githubusercontent.com/u/8030877?v=3","gravatar_id":"","url":"https://api.github.com/users/naw","html_url":"https://github.com/naw","followers_url":"https://api.github.com/users/naw/followers","following_url":"https://api.github.com/users/naw/following{/other_user}","gists_url":"https://api.github.com/users/naw/gists{/gist_id}","starred_url":"https://api.github.com/users/naw/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/naw/subscriptions","organizations_url":"https://api.github.com/users/naw/orgs","repos_url":"https://api.github.com/users/naw/repos","events_url":"https://api.github.com/users/naw/events{/privacy}","received_events_url":"https://api.github.com/users/naw/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":1,"created_at":"2016-08-25T00:58:27Z","updated_at":"2016-08-25T03:53:46Z","closed_at":null,"pull_request":{"url":"https://api.github.com/repos/airblade/paper_trail/pulls/854","html_url":"https://github.com/airblade/paper_trail/pull/854","diff_url":"https://github.com/airblade/paper_trail/pull/854.diff","patch_url":"https://github.com/airblade/paper_trail/pull/854.patch"},"body":"Closes #830\r\n\r\nThis PR updates the install generator to create an initializer:\r\n\r\n```ruby\r\n# config/initializers/paper_trail.rb\r\nPaperTrail.config.track_associations = false\r\n```\r\n\r\nIf `--with-associations` is used, the generator sets the value to `true` instead of `false`.\r\n\r\nAlso included in this PR is documentation [suggested here](https://github.com/airblade/paper_trail/issues/830#issuecomment-230179211) as well as other documentation improvements focusing on the `track_associations` configuration, configuration in general, and basic upgrade information regarding tracking associations.\r\n\r\nSome of this might be overkill, but updating from v3 to v5, I was a little surprised to see a deprecation warning for a feature I wasn't even using, and further surprised when I didn't see mention of an initializer in the docs (or an aggregated configuration section at all). \r\n\r\nPlease feel free to remove anything you feel is overkill, edit, or suggest improvements. Thanks!"},"comment":{"url":"https://api.github.com/repos/airblade/paper_trail/issues/comments/242274766","html_url":"https://github.com/airblade/paper_trail/pull/854#issuecomment-242274766","issue_url":"https://api.github.com/repos/airblade/paper_trail/issues/854","id":242274766,"user":{"login":"jaredbeck","id":380809,"avatar_url":"https://avatars.githubusercontent.com/u/380809?v=3","gravatar_id":"","url":"https://api.github.com/users/jaredbeck","html_url":"https://github.com/jaredbeck","followers_url":"https://api.github.com/users/jaredbeck/followers","following_url":"https://api.github.com/users/jaredbeck/following{/other_user}","gists_url":"https://api.github.com/users/jaredbeck/gists{/gist_id}","starred_url":"https://api.github.com/users/jaredbeck/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/jaredbeck/subscriptions","organizations_url":"https://api.github.com/users/jaredbeck/orgs","repos_url":"https://api.github.com/users/jaredbeck/repos","events_url":"https://api.github.com/users/jaredbeck/events{/privacy}","received_events_url":"https://api.github.com/users/jaredbeck/received_events","type":"User","site_admin":false},"created_at":"2016-08-25T03:53:46Z","updated_at":"2016-08-25T03:53:46Z","body":"Thanks Nathan. The changes to the generator look fine. :+1: \r\n\r\nI have some suggestions about the proposed documentation.\r\n\r\nAdding a \"configuration\" section is not in keeping with the rest of the document. We already have a few sections that deal with configuration, topically, like section 2 \"Limiting What is Versioned, and When\", and section 4 \"Saving More Information About Versions\". So, discussion of the `track_associations` option should go under section 4.b. \"Associations\".\r\n\r\nRegarding the proposed \"Upgrading\" section. At first glance, I agree that it seems overkill. All of that information is already in the changelog. However, to someone less familiar with the project, it may be helpful. I like how the [rails upgrading guide][1] is organized, where each section focuses on a particular upgrade, e.g. \"Upgrading from Rails 4.2 to Rails 5.0\". Then, within that section there is a list of concrete steps to be taken. Would you mind removing the \"upgrading\" section from this PR and we can discuss it in a separate PR? Thanks.\r\n\r\n[1]: http://guides.rubyonrails.org/upgrading_ruby_on_rails.html"}}
{"actor":{"display_login":"jaredbeck"}}