GitHub PullRequestReviewCommentEvent at 2014-05-05 09:05:49
Repository: docker
Actor: ostezer
Payload: {"comment":{"url":"https://api.github.com/repos/dotcloud/docker/pulls/comments/12271729","id":12271729,"diff_hunk":"@@ -47,40 +48,39 @@ you can connect and see your changes.\n \n In the root of the `docker` source directory:\n \n-    cd docker\n-\n-Run:\n-\n     make docs\n \n If you have any issues you need to debug, you can use `make docs-shell` and\n then run `mkdocs serve`\n \n-# Contributing\n-\n-* Follow the contribution guidelines ([see\n-  `../CONTRIBUTING.md`](../CONTRIBUTING.md)).\n-* [Remember to sign your work!](../CONTRIBUTING.md#sign-your-work)\n+### Examples\n \n-Working using GitHub's file editor\n-----------------------------------\n+When writing examples give the user hints by making them resemble what\n+they see in their shell:\n \n-Alternatively, for small changes and typos you might want to use\n-GitHub's built in file editor. It allows you to preview your changes\n-right on-line (though there can be some differences between GitHub\n-Markdown and mkdocs Markdown). Just be careful not to create many commits.\n-And you must still [sign your work!](../CONTRIBUTING.md#sign-your-work)\n+* Indent shell examples by 4 spaces so they get rendered as code.\n+* Start typed commands with `$ ` (dollar space), so that they are easily\n+differentiated from program output.\n+* Program output has no prefix.\n+* Comments begin with `# ` (hash space).\n+* In-container shell commands begin with `$$ ` (dollar dollar space).\n \n-Images\n-------\n+### Images\n \n When you need to add images, try to make them as small as possible\n (e.g. as gifs). Usually images should go in the same directory as the\n `.md` file which references them, or in a subdirectory if one already\n exists.\n \n-Publishing Documentation\n-------------------------\n+## Working using GitHub's file editor\n+\n+Alternatively, for small changes and typos you might want to use\n+GitHub's built in file editor. It allows you to preview your changes\n+right on-line (though there can be some differences between GitHub\n+Markdown and mkdocs Markdown). Just be careful not to create many commits.","path":"docs/README.md","position":79,"original_position":79,"commit_id":"29e35b99be81eaad5d8ab6b6827596b93e75e936","original_commit_id":"29e35b99be81eaad5d8ab6b6827596b93e75e936","user":{"login":"ostezer","id":6561122,"avatar_url":"https://avatars.githubusercontent.com/u/6561122?","gravatar_id":"26dc2b32b9e753823aef55e89687a9fc","url":"https://api.github.com/users/ostezer","html_url":"https://github.com/ostezer","followers_url":"https://api.github.com/users/ostezer/followers","following_url":"https://api.github.com/users/ostezer/following{/other_user}","gists_url":"https://api.github.com/users/ostezer/gists{/gist_id}","starred_url":"https://api.github.com/users/ostezer/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/ostezer/subscriptions","organizations_url":"https://api.github.com/users/ostezer/orgs","repos_url":"https://api.github.com/users/ostezer/repos","events_url":"https://api.github.com/users/ostezer/events{/privacy}","received_events_url":"https://api.github.com/users/ostezer/received_events","type":"User","site_admin":false},"body":"mkdocs > MkDocs\r\nHowever it's actually:\r\nPython-Markdown","created_at":"2014-05-05T09:05:49Z","updated_at":"2014-05-05T09:05:49Z","html_url":"https://github.com/dotcloud/docker/pull/5587#discussion_r12271729","pull_request_url":"https://api.github.com/repos/dotcloud/docker/pulls/5587","_links":{"self":{"href":"https://api.github.com/repos/dotcloud/docker/pulls/comments/12271729"},"html":{"href":"https://github.com/dotcloud/docker/pull/5587#discussion_r12271729"},"pull_request":{"href":"https://api.github.com/repos/dotcloud/docker/pulls/5587"}}}}