{"action":"created","comment":{"url":"https://api.github.com/repos/projectacrn/acrn-hypervisor/pulls/comments/190043823","pull_request_review_id":122341881,"id":190043823,"diff_hunk":"@@ -0,0 +1,378 @@\n+.. _doc_guidelines:\n+\n+Documentation Guidelines\n+########################\n+\n+Project ACRN content is written using the `reStructuredText`_ markup\n+language (``.rst`` file extension) with Sphinx extensions, and processed\n+using Sphinx to create a formatted standalone website.  Developers can\n+view this content either in its raw form as .rst markup files, or (with\n+Sphinx installed) they can build the documentation using the Makefile\n+(on Linux systems) to\n+generate the HTML content. The HTML content can then be viewed using a\n+web browser. This same ``.rst`` content is also fed into the\n+`Project ACRN documentation`_ website.\n+\n+You can read details about `reStructuredText`_\n+and about `Sphinx extensions`_ from their respective websites.\n+\n+.. _Sphinx extensions: http://www.sphinx-doc.org/en/stable/contents.html\n+.. _reStructuredText: http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html\n+.. _Sphinx Inline Markup:  http://sphinx-doc.org/markup/inline.html#inline-markup\n+.. _Project ACRN documentation:  http://projectacrn.github.io\n+\n+This document provides a quick reference for commonly used reST and\n+Sphinx-defined directives and roles used to create the documentation\n+you're reading.\n+\n+Headings\n+********\n+\n+While reST allows use of both and overline and matching underline to\n+indicate a heading, we only use an underline indicator for headings.\n+\n+* Document title (h1) use \"#\" for the underline character\n+* First section heading level (h2) use \"*\"","path":"doc/contribute/doc_guidelines.rst","position":35,"original_position":35,"commit_id":"f9dbf617eb40dadd64e2f65d7a18cb4b970ccd80","original_commit_id":"f9dbf617eb40dadd64e2f65d7a18cb4b970ccd80","user":{"login":"dbkinder","id":11063618,"avatar_url":"https://avatars0.githubusercontent.com/u/11063618?v=4","gravatar_id":"","url":"https://api.github.com/users/dbkinder","html_url":"https://github.com/dbkinder","followers_url":"https://api.github.com/users/dbkinder/followers","following_url":"https://api.github.com/users/dbkinder/following{/other_user}","gists_url":"https://api.github.com/users/dbkinder/gists{/gist_id}","starred_url":"https://api.github.com/users/dbkinder/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/dbkinder/subscriptions","organizations_url":"https://api.github.com/users/dbkinder/orgs","repos_url":"https://api.github.com/users/dbkinder/repos","events_url":"https://api.github.com/users/dbkinder/events{/privacy}","received_events_url":"https://api.github.com/users/dbkinder/received_events","type":"User","site_admin":false},"body":"I'm using the HTML tag references here, which likely is the cause for confusion.  I'll just remove the HTML references.","created_at":"2018-05-22T20:34:55Z","updated_at":"2018-05-22T20:34:55Z","html_url":"https://github.com/projectacrn/acrn-hypervisor/pull/249#discussion_r190043823","pull_request_url":"https://api.github.com/repos/projectacrn/acrn-hypervisor/pulls/249","author_association":"CONTRIBUTOR","_links":{"self":{"href":"https://api.github.com/repos/projectacrn/acrn-hypervisor/pulls/comments/190043823"},"html":{"href":"https://github.com/projectacrn/acrn-hypervisor/pull/249#discussion_r190043823"},"pull_request":{"href":"https://api.github.com/repos/projectacrn/acrn-hypervisor/pulls/249"}},"in_reply_to_id":190030544},"pull_request":{"url":"https://api.github.com/repos/projectacrn/acrn-hypervisor/pulls/249","id":189766373,"html_url":"https://github.com/projectacrn/acrn-hypervisor/pull/249","diff_url":"https://github.com/projectacrn/acrn-hypervisor/pull/249.diff","patch_url":"https://github.com/projectacrn/acrn-hypervisor/pull/249.patch","issue_url":"https://api.github.com/repos/projectacrn/acrn-hypervisor/issues/249","number":249,"state":"open","locked":false,"title":"doc: add doc contributing guide, plus cleanup","user":{"login":"dbkinder","id":11063618,"avatar_url":"https://avatars0.githubusercontent.com/u/11063618?v=4","gravatar_id":"","url":"https://api.github.com/users/dbkinder","html_url":"https://github.com/dbkinder","followers_url":"https://api.github.com/users/dbkinder/followers","following_url":"https://api.github.com/users/dbkinder/following{/other_user}","gists_url":"https://api.github.com/users/dbkinder/gists{/gist_id}","starred_url":"https://api.github.com/users/dbkinder/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/dbkinder/subscriptions","organizations_url":"https://api.github.com/users/dbkinder/orgs","repos_url":"https://api.github.com/users/dbkinder/repos","events_url":"https://api.github.com/users/dbkinder/events{/privacy}","received_events_url":"https://api.github.com/users/dbkinder/received_events","type":"User","site_admin":false},"body":"Add documentation contributing information with project specific\r\nrecommentations along with some common reST and Sphinx constructs.\r\nReorganize contributing section to fit this new doc in.\r\n\r\nAlso\r\n\r\n* Cleanup stray file (CODEOWNERS) from when docs were in their own repo.\r\n* Remove licensing footer on generated pages (not really needed).\r\n* Pull replacement strings into substitutions.txt for easier management.\r\n\r\nSigned-off-by: David B. Kinder <david.b.kinder@intel.com>","created_at":"2018-05-22T19:22:29Z","updated_at":"2018-05-22T20:34:55Z","closed_at":null,"merged_at":null,"merge_commit_sha":"faf0d59a9e10a44542767c19a412cdb4c898f870","assignee":null,"assignees":[],"requested_reviewers":[{"login":"ailun258","id":20394804,"avatar_url":"https://avatars2.githubusercontent.com/u/20394804?v=4","gravatar_id":"","url":"https://api.github.com/users/ailun258","html_url":"https://github.com/ailun258","followers_url":"https://api.github.com/users/ailun258/followers","following_url":"https://api.github.com/users/ailun258/following{/other_user}","gists_url":"https://api.github.com/users/ailun258/gists{/gist_id}","starred_url":"https://api.github.com/users/ailun258/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/ailun258/subscriptions","organizations_url":"https://api.github.com/users/ailun258/orgs","repos_url":"https://api.github.com/users/ailun258/repos","events_url":"https://api.github.com/users/ailun258/events{/privacy}","received_events_url":"https://api.github.com/users/ailun258/received_events","type":"User","site_admin":false}],"requested_teams":[],"labels":[],"milestone":null,"commits_url":"https://api.github.com/repos/projectacrn/acrn-hypervisor/pulls/249/commits","review_comments_url":"https://api.github.com/repos/projectacrn/acrn-hypervisor/pulls/249/comments","review_comment_url":"https://api.github.com/repos/projectacrn/acrn-hypervisor/pulls/comments{/number}","comments_url":"https://api.github.com/repos/projectacrn/acrn-hypervisor/issues/249/comments","statuses_url":"https://api.github.com/repos/projectacrn/acrn-hypervisor/statuses/f9dbf617eb40dadd64e2f65d7a18cb4b970ccd80","head":{"label":"dbkinder:fix-contribute","ref":"fix-contribute","sha":"f9dbf617eb40dadd64e2f65d7a18cb4b970ccd80","user":{"login":"dbkinder","id":11063618,"avatar_url":"https://avatars0.githubusercontent.com/u/11063618?v=4","gravatar_id":"","url":"https://api.github.com/users/dbkinder","html_url":"https://github.com/dbkinder","followers_url":"https://api.github.com/users/dbkinder/followers","following_url":"https://api.github.com/users/dbkinder/following{/other_user}","gists_url":"https://api.github.com/users/dbkinder/gists{/gist_id}","starred_url":"https://api.github.com/users/dbkinder/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/dbkinder/subscriptions","organizations_url":"https://api.github.com/users/dbkinder/orgs","repos_url":"https://api.github.com/users/dbkinder/repos","events_url":"https://api.github.com/users/dbkinder/events{/privacy}","received_events_url":"https://api.github.com/users/dbkinder/received_events","type":"User","site_admin":false},"repo":{"id":124300887,"name":"acrn-hypervisor","full_name":"dbkinder/acrn-hypervisor","owner":{"login":"dbkinder","id":11063618,"avatar_url":"https://avatars0.githubusercontent.com/u/11063618?v=4","gravatar_id":"","url":"https://api.github.com/users/dbkinder","html_url":"https://github.com/dbkinder","followers_url":"https://api.github.com/users/dbkinder/followers","following_url":"https://api.github.com/users/dbkinder/following{/other_user}","gists_url":"https://api.github.com/users/dbkinder/gists{/gist_id}","starred_url":"https://api.github.com/users/dbkinder/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/dbkinder/subscriptions","organizations_url":"https://api.github.com/users/dbkinder/orgs","repos_url":"https://api.github.com/users/dbkinder/repos","events_url":"https://api.github.com/users/dbkinder/events{/privacy}","received_events_url":"https://api.github.com/users/dbkinder/received_events","type":"User","site_admin":false},"private":false,"html_url":"https://github.com/dbkinder/acrn-hypervisor","description":null,"fork":true,"url":"https://api.github.com/repos/dbkinder/acrn-hypervisor","forks_url":"https://api.github.com/repos/dbkinder/acrn-hypervisor/forks","keys_url":"https://api.github.com/repos/dbkinder/acrn-hypervisor/keys{/key_id}","collaborators_url":"https://api.github.com/repos/dbkinder/acrn-hypervisor/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/dbkinder/acrn-hypervisor/teams","hooks_url":"https://api.github.com/repos/dbkinder/acrn-hypervisor/hooks","issue_events_url":"https://api.github.com/repos/dbkinder/acrn-hypervisor/issues/events{/number}","events_url":"https://api.github.com/repos/dbkinder/acrn-hypervisor/events","assignees_url":"https://api.github.com/repos/dbkinder/acrn-hypervisor/assignees{/user}","branches_url":"https://api.github.com/repos/dbkinder/acrn-hypervisor/branches{/branch}","tags_url":"https://api.github.com/repos/dbkinder/acrn-hypervisor/tags","blobs_url":"https://api.github.com/repos/dbkinder/acrn-hypervisor/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/dbkinder/acrn-hypervisor/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/dbkinder/acrn-hypervisor/git/refs{/sha}","trees_url":"https://api.github.com/repos/dbkinder/acrn-hypervisor/git/trees{/sha}","statuses_url":"https://api.github.com/repos/dbkinder/acrn-hypervisor/statuses/{sha}","languages_url":"https://api.github.com/repos/dbkinder/acrn-hypervisor/languages","stargazers_url":"https://api.github.com/repos/dbkinder/acrn-hypervisor/stargazers","contributors_url":"https://api.github.com/repos/dbkinder/acrn-hypervisor/contributors","subscribers_url":"https://api.github.com/repos/dbkinder/acrn-hypervisor/subscribers","subscription_url":"https://api.github.com/repos/dbkinder/acrn-hypervisor/subscription","commits_url":"https://api.github.com/repos/dbkinder/acrn-hypervisor/commits{/sha}","git_commits_url":"https://api.github.com/repos/dbkinder/acrn-hypervisor/git/commits{/sha}","comments_url":"https://api.github.com/repos/dbkinder/acrn-hypervisor/comments{/number}","issue_comment_url":"https://api.github.com/repos/dbkinder/acrn-hypervisor/issues/comments{/number}","contents_url":"https://api.github.com/repos/dbkinder/acrn-hypervisor/contents/{+path}","compare_url":"https://api.github.com/repos/dbkinder/acrn-hypervisor/compare/{base}...{head}","merges_url":"https://api.github.com/repos/dbkinder/acrn-hypervisor/merges","archive_url":"https://api.github.com/repos/dbkinder/acrn-hypervisor/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/dbkinder/acrn-hypervisor/downloads","issues_url":"https://api.github.com/repos/dbkinder/acrn-hypervisor/issues{/number}","pulls_url":"https://api.github.com/repos/dbkinder/acrn-hypervisor/pulls{/number}","milestones_url":"https://api.github.com/repos/dbkinder/acrn-hypervisor/milestones{/number}","notifications_url":"https://api.github.com/repos/dbkinder/acrn-hypervisor/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/dbkinder/acrn-hypervisor/labels{/name}","releases_url":"https://api.github.com/repos/dbkinder/acrn-hypervisor/releases{/id}","deployments_url":"https://api.github.com/repos/dbkinder/acrn-hypervisor/deployments","created_at":"2018-03-07T22:13:55Z","updated_at":"2018-05-22T14:54:38Z","pushed_at":"2018-05-22T19:20:48Z","git_url":"git://github.com/dbkinder/acrn-hypervisor.git","ssh_url":"git@github.com:dbkinder/acrn-hypervisor.git","clone_url":"https://github.com/dbkinder/acrn-hypervisor.git","svn_url":"https://github.com/dbkinder/acrn-hypervisor","homepage":null,"size":5454,"stargazers_count":0,"watchers_count":0,"language":"C","has_issues":false,"has_projects":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":0,"mirror_url":null,"archived":false,"open_issues_count":0,"license":{"key":"bsd-3-clause","name":"BSD 3-Clause \"New\" or \"Revised\" License","spdx_id":"BSD-3-Clause","url":"https://api.github.com/licenses/bsd-3-clause"},"forks":0,"open_issues":0,"watchers":0,"default_branch":"master"}},"base":{"label":"projectacrn:master","ref":"master","sha":"eb943e7b13bc94fb32ccaa5f0b2603c907a71ba0","user":{"login":"projectacrn","id":36865262,"avatar_url":"https://avatars1.githubusercontent.com/u/36865262?v=4","gravatar_id":"","url":"https://api.github.com/users/projectacrn","html_url":"https://github.com/projectacrn","followers_url":"https://api.github.com/users/projectacrn/followers","following_url":"https://api.github.com/users/projectacrn/following{/other_user}","gists_url":"https://api.github.com/users/projectacrn/gists{/gist_id}","starred_url":"https://api.github.com/users/projectacrn/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/projectacrn/subscriptions","organizations_url":"https://api.github.com/users/projectacrn/orgs","repos_url":"https://api.github.com/users/projectacrn/repos","events_url":"https://api.github.com/users/projectacrn/events{/privacy}","received_events_url":"https://api.github.com/users/projectacrn/received_events","type":"Organization","site_admin":false},"repo":{"id":123983554,"name":"acrn-hypervisor","full_name":"projectacrn/acrn-hypervisor","owner":{"login":"projectacrn","id":36865262,"avatar_url":"https://avatars1.githubusercontent.com/u/36865262?v=4","gravatar_id":"","url":"https://api.github.com/users/projectacrn","html_url":"https://github.com/projectacrn","followers_url":"https://api.github.com/users/projectacrn/followers","following_url":"https://api.github.com/users/projectacrn/following{/other_user}","gists_url":"https://api.github.com/users/projectacrn/gists{/gist_id}","starred_url":"https://api.github.com/users/projectacrn/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/projectacrn/subscriptions","organizations_url":"https://api.github.com/users/projectacrn/orgs","repos_url":"https://api.github.com/users/projectacrn/repos","events_url":"https://api.github.com/users/projectacrn/events{/privacy}","received_events_url":"https://api.github.com/users/projectacrn/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/projectacrn/acrn-hypervisor","description":"Project ACRN hypervisor ","fork":false,"url":"https://api.github.com/repos/projectacrn/acrn-hypervisor","forks_url":"https://api.github.com/repos/projectacrn/acrn-hypervisor/forks","keys_url":"https://api.github.com/repos/projectacrn/acrn-hypervisor/keys{/key_id}","collaborators_url":"https://api.github.com/repos/projectacrn/acrn-hypervisor/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/projectacrn/acrn-hypervisor/teams","hooks_url":"https://api.github.com/repos/projectacrn/acrn-hypervisor/hooks","issue_events_url":"https://api.github.com/repos/projectacrn/acrn-hypervisor/issues/events{/number}","events_url":"https://api.github.com/repos/projectacrn/acrn-hypervisor/events","assignees_url":"https://api.github.com/repos/projectacrn/acrn-hypervisor/assignees{/user}","branches_url":"https://api.github.com/repos/projectacrn/acrn-hypervisor/branches{/branch}","tags_url":"https://api.github.com/repos/projectacrn/acrn-hypervisor/tags","blobs_url":"https://api.github.com/repos/projectacrn/acrn-hypervisor/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/projectacrn/acrn-hypervisor/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/projectacrn/acrn-hypervisor/git/refs{/sha}","trees_url":"https://api.github.com/repos/projectacrn/acrn-hypervisor/git/trees{/sha}","statuses_url":"https://api.github.com/repos/projectacrn/acrn-hypervisor/statuses/{sha}","languages_url":"https://api.github.com/repos/projectacrn/acrn-hypervisor/languages","stargazers_url":"https://api.github.com/repos/projectacrn/acrn-hypervisor/stargazers","contributors_url":"https://api.github.com/repos/projectacrn/acrn-hypervisor/contributors","subscribers_url":"https://api.github.com/repos/projectacrn/acrn-hypervisor/subscribers","subscription_url":"https://api.github.com/repos/projectacrn/acrn-hypervisor/subscription","commits_url":"https://api.github.com/repos/projectacrn/acrn-hypervisor/commits{/sha}","git_commits_url":"https://api.github.com/repos/projectacrn/acrn-hypervisor/git/commits{/sha}","comments_url":"https://api.github.com/repos/projectacrn/acrn-hypervisor/comments{/number}","issue_comment_url":"https://api.github.com/repos/projectacrn/acrn-hypervisor/issues/comments{/number}","contents_url":"https://api.github.com/repos/projectacrn/acrn-hypervisor/contents/{+path}","compare_url":"https://api.github.com/repos/projectacrn/acrn-hypervisor/compare/{base}...{head}","merges_url":"https://api.github.com/repos/projectacrn/acrn-hypervisor/merges","archive_url":"https://api.github.com/repos/projectacrn/acrn-hypervisor/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/projectacrn/acrn-hypervisor/downloads","issues_url":"https://api.github.com/repos/projectacrn/acrn-hypervisor/issues{/number}","pulls_url":"https://api.github.com/repos/projectacrn/acrn-hypervisor/pulls{/number}","milestones_url":"https://api.github.com/repos/projectacrn/acrn-hypervisor/milestones{/number}","notifications_url":"https://api.github.com/repos/projectacrn/acrn-hypervisor/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/projectacrn/acrn-hypervisor/labels{/name}","releases_url":"https://api.github.com/repos/projectacrn/acrn-hypervisor/releases{/id}","deployments_url":"https://api.github.com/repos/projectacrn/acrn-hypervisor/deployments","created_at":"2018-03-05T21:52:25Z","updated_at":"2018-05-22T13:30:29Z","pushed_at":"2018-05-22T19:22:30Z","git_url":"git://github.com/projectacrn/acrn-hypervisor.git","ssh_url":"git@github.com:projectacrn/acrn-hypervisor.git","clone_url":"https://github.com/projectacrn/acrn-hypervisor.git","svn_url":"https://github.com/projectacrn/acrn-hypervisor","homepage":"","size":5669,"stargazers_count":160,"watchers_count":160,"language":"C","has_issues":true,"has_projects":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":93,"mirror_url":null,"archived":false,"open_issues_count":25,"license":{"key":"bsd-3-clause","name":"BSD 3-Clause \"New\" or \"Revised\" License","spdx_id":"BSD-3-Clause","url":"https://api.github.com/licenses/bsd-3-clause"},"forks":93,"open_issues":25,"watchers":160,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/projectacrn/acrn-hypervisor/pulls/249"},"html":{"href":"https://github.com/projectacrn/acrn-hypervisor/pull/249"},"issue":{"href":"https://api.github.com/repos/projectacrn/acrn-hypervisor/issues/249"},"comments":{"href":"https://api.github.com/repos/projectacrn/acrn-hypervisor/issues/249/comments"},"review_comments":{"href":"https://api.github.com/repos/projectacrn/acrn-hypervisor/pulls/249/comments"},"review_comment":{"href":"https://api.github.com/repos/projectacrn/acrn-hypervisor/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/projectacrn/acrn-hypervisor/pulls/249/commits"},"statuses":{"href":"https://api.github.com/repos/projectacrn/acrn-hypervisor/statuses/f9dbf617eb40dadd64e2f65d7a18cb4b970ccd80"}},"author_association":"CONTRIBUTOR"}}
{"actor":{"display_login":"dbkinder"}}