{"action":"created","issue":{"url":"https://api.github.com/repos/puppetlabs/puppetlabs-apt/issues/510","labels_url":"https://api.github.com/repos/puppetlabs/puppetlabs-apt/issues/510/labels{/name}","comments_url":"https://api.github.com/repos/puppetlabs/puppetlabs-apt/issues/510/comments","events_url":"https://api.github.com/repos/puppetlabs/puppetlabs-apt/issues/510/events","html_url":"https://github.com/puppetlabs/puppetlabs-apt/pull/510","id":70805694,"number":510,"title":"Update README per DOC-1503","user":{"login":"psoloway","id":10080388,"avatar_url":"https://avatars.githubusercontent.com/u/10080388?v=3","gravatar_id":"","url":"https://api.github.com/users/psoloway","html_url":"https://github.com/psoloway","followers_url":"https://api.github.com/users/psoloway/followers","following_url":"https://api.github.com/users/psoloway/following{/other_user}","gists_url":"https://api.github.com/users/psoloway/gists{/gist_id}","starred_url":"https://api.github.com/users/psoloway/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/psoloway/subscriptions","organizations_url":"https://api.github.com/users/psoloway/orgs","repos_url":"https://api.github.com/users/psoloway/repos","events_url":"https://api.github.com/users/psoloway/events{/privacy}","received_events_url":"https://api.github.com/users/psoloway/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":3,"created_at":"2015-04-24T22:02:05Z","updated_at":"2015-04-25T09:38:12Z","closed_at":null,"pull_request":{"url":"https://api.github.com/repos/puppetlabs/puppetlabs-apt/pulls/510","html_url":"https://github.com/puppetlabs/puppetlabs-apt/pull/510","diff_url":"https://github.com/puppetlabs/puppetlabs-apt/pull/510.diff","patch_url":"https://github.com/puppetlabs/puppetlabs-apt/pull/510.patch"},"body":"1. Make sure that for each parameter, where applicable, there is a default value.\r\n2. Make sure that for each parameter that's applicable, there is a note if the parameter is optional.\r\n3. Make sure the links in the README work and are accurate.\r\n4. Update the link in the Contributing section to point here: https://docs.puppetlabs.com/forge/contributing.html\r\n5. General copyediting.\r\n\r\n* Add a ToC\r\n* Reorganize Usage & Reference sections\r\n* Standardize capitalization of \"Apt\" (as opposed to \"apt\", the module)\r\n* Standardize Development section\r\n\r\nApply edits from @jbondpdx\r\n\r\n* Re-emphasize the warning about short key names\r\n* Restore the “What apt affects” section\r\n* Re-correct capitalization of “Apt” (where it had reverted to “APT”)\r\n* Clarify OS compatibility in Limitations and elsewhere\r\n* Various edits for clarity"},"comment":{"url":"https://api.github.com/repos/puppetlabs/puppetlabs-apt/issues/comments/96169126","html_url":"https://github.com/puppetlabs/puppetlabs-apt/pull/510#issuecomment-96169126","issue_url":"https://api.github.com/repos/puppetlabs/puppetlabs-apt/issues/510","id":96169126,"user":{"login":"daenney","id":569574,"avatar_url":"https://avatars.githubusercontent.com/u/569574?v=3","gravatar_id":"","url":"https://api.github.com/users/daenney","html_url":"https://github.com/daenney","followers_url":"https://api.github.com/users/daenney/followers","following_url":"https://api.github.com/users/daenney/following{/other_user}","gists_url":"https://api.github.com/users/daenney/gists{/gist_id}","starred_url":"https://api.github.com/users/daenney/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/daenney/subscriptions","organizations_url":"https://api.github.com/users/daenney/orgs","repos_url":"https://api.github.com/users/daenney/repos","events_url":"https://api.github.com/users/daenney/events{/privacy}","received_events_url":"https://api.github.com/users/daenney/received_events","type":"User","site_admin":false},"created_at":"2015-04-25T09:38:12Z","updated_at":"2015-04-25T09:38:12Z","body":"Can someone explain to me why we can't have the syntax cue's? If they're not supported on \"the main docs side\" they should simply not render, not cause rendering issues and it will render correctly on Github giving us a nicer README here."}}