{"action":"created","issue":{"url":"https://api.github.com/repos/minishift/minishift/issues/836","repository_url":"https://api.github.com/repos/minishift/minishift","labels_url":"https://api.github.com/repos/minishift/minishift/issues/836/labels{/name}","comments_url":"https://api.github.com/repos/minishift/minishift/issues/836/comments","events_url":"https://api.github.com/repos/minishift/minishift/issues/836/events","html_url":"https://github.com/minishift/minishift/pull/836","id":224753396,"number":836,"title":"[WIP] Issue #618 update \"writing and publishing docs\" topic","user":{"login":"thatdocslady","id":6662054,"avatar_url":"https://avatars0.githubusercontent.com/u/6662054?v=3","gravatar_id":"","url":"https://api.github.com/users/thatdocslady","html_url":"https://github.com/thatdocslady","followers_url":"https://api.github.com/users/thatdocslady/followers","following_url":"https://api.github.com/users/thatdocslady/following{/other_user}","gists_url":"https://api.github.com/users/thatdocslady/gists{/gist_id}","starred_url":"https://api.github.com/users/thatdocslady/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/thatdocslady/subscriptions","organizations_url":"https://api.github.com/users/thatdocslady/orgs","repos_url":"https://api.github.com/users/thatdocslady/repos","events_url":"https://api.github.com/users/thatdocslady/events{/privacy}","received_events_url":"https://api.github.com/users/thatdocslady/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":0,"created_at":"2017-04-27T11:25:23Z","updated_at":"2017-05-02T12:37:10Z","closed_at":null,"pull_request":{"url":"https://api.github.com/repos/minishift/minishift/pulls/836","html_url":"https://github.com/minishift/minishift/pull/836","diff_url":"https://github.com/minishift/minishift/pull/836.diff","patch_url":"https://github.com/minishift/minishift/pull/836.patch"},"body":"Fixes issue #618 \r\n\r\nThis PR aims to formalize the documentation guidelines and conventions. I also proofread the topic itself to reflect the proposed conventions so you can see what a \"clean\" topic looks like.\r\n\r\nTL;DR: Follow OpenShift doc guidelines whenever possible, exceptions noted.\r\n\r\nI wrote some specific examples of common conventions that people might have questions about, but the basic guideline is to keep it simple and not overkill with tags, because we need the docs to be parsed through multiple toolchains upstream and downstream.\r\n\r\nNOTE: We are currently working in RH CCS (content services) to unify the AsciiDoc conventions from several products into a single source-of-truth. This will impact Minishift but it will take some time and it will be partially based on OpenShift conventions so future changes will probably be minor.\r\n\r\nPlease review and hopefully we can reach an agreement, and after we finalize this I will go ahead and handle #691 so that the doc set follows the conventions."},"comment":{"url":"https://api.github.com/repos/minishift/minishift/issues/comments/298623036","html_url":"https://github.com/minishift/minishift/pull/836#issuecomment-298623036","issue_url":"https://api.github.com/repos/minishift/minishift/issues/836","id":298623036,"user":{"login":"hferentschik","id":296354,"avatar_url":"https://avatars3.githubusercontent.com/u/296354?v=3","gravatar_id":"","url":"https://api.github.com/users/hferentschik","html_url":"https://github.com/hferentschik","followers_url":"https://api.github.com/users/hferentschik/followers","following_url":"https://api.github.com/users/hferentschik/following{/other_user}","gists_url":"https://api.github.com/users/hferentschik/gists{/gist_id}","starred_url":"https://api.github.com/users/hferentschik/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/hferentschik/subscriptions","organizations_url":"https://api.github.com/users/hferentschik/orgs","repos_url":"https://api.github.com/users/hferentschik/repos","events_url":"https://api.github.com/users/hferentschik/events{/privacy}","received_events_url":"https://api.github.com/users/hferentschik/received_events","type":"User","site_admin":false},"created_at":"2017-05-02T12:37:10Z","updated_at":"2017-05-02T12:37:10Z","body":"I also suggest to adopt and include a \"one sentence per line\" approach. This makes reviews much easier and avoids unnecessary overflows."}}
{"actor":{"display_login":"hferentschik"}}