GitHub PullRequestReviewCommentEvent at 2014-12-15 08:50:25
Repository: sulu-docs
Actor: danrot
Payload: {"action":"created","comment":{"url":"https://api.github.com/repos/sulu-cmf/sulu-docs/pulls/comments/21810945","id":21810945,"diff_hunk":"@@ -0,0 +1,81 @@\n+Sauce Labs\n+==========\n+\n+`Sauce Labs`_ is a service which allows you to run browser tests\n+remotely. Like `Travis CI`_ it is free for open source projects such\n+as SuluCMF.\n+\n+It functions in a similar way to the :doc:`getting-started` tests which you run\n+locally, but instead of connecting to a local Selenium server you\n+connect to the `Sauce Labs`_ server.\n+\n+It works briefly as follows, you:\n+\n+- Running your local web server\n+- You download and run the Sauce Labs connection tunnel\n+- You run your tests\n+- Your test runner talks to the Sauce Labs server\n+- The Sauce Labs server connects to *your* webserver through the tunnel\n+- The tests are rendered in the browser on the Sauce Labs server\n+- You watch the tests in real-time on the Sauce Labs web page.\n+\n+Prerequisites\n+-------------\n+\n+- You will need a `username` and `access-key` on Sauce Labs before continuing.\n+  `Sign-up here`_!\n+\n+Downloading and Running the Connect Daemon\n+------------------------------------------\n+\n+To run the tests remotely you will need to install and run the connect daemon.\n+This application will establish a ","path":"developer/behat/sauce-labs.rst","position":32,"original_position":32,"commit_id":"ba48f45e669dbbebdf0938870957f1d302002700","original_commit_id":"ba48f45e669dbbebdf0938870957f1d302002700","user":{"login":"danrot","id":405874,"avatar_url":"https://avatars.githubusercontent.com/u/405874?v=3","gravatar_id":"","url":"https://api.github.com/users/danrot","html_url":"https://github.com/danrot","followers_url":"https://api.github.com/users/danrot/followers","following_url":"https://api.github.com/users/danrot/following{/other_user}","gists_url":"https://api.github.com/users/danrot/gists{/gist_id}","starred_url":"https://api.github.com/users/danrot/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/danrot/subscriptions","organizations_url":"https://api.github.com/users/danrot/orgs","repos_url":"https://api.github.com/users/danrot/repos","events_url":"https://api.github.com/users/danrot/events{/privacy}","received_events_url":"https://api.github.com/users/danrot/received_events","type":"User","site_admin":false},"body":"Just a half sentence?","created_at":"2014-12-15T08:50:25Z","updated_at":"2014-12-15T08:50:25Z","html_url":"https://github.com/sulu-cmf/sulu-docs/pull/5#discussion_r21810945","pull_request_url":"https://api.github.com/repos/sulu-cmf/sulu-docs/pulls/5","_links":{"self":{"href":"https://api.github.com/repos/sulu-cmf/sulu-docs/pulls/comments/21810945"},"html":{"href":"https://github.com/sulu-cmf/sulu-docs/pull/5#discussion_r21810945"},"pull_request":{"href":"https://api.github.com/repos/sulu-cmf/sulu-docs/pulls/5"}}},"pull_request":{"url":"https://api.github.com/repos/sulu-cmf/sulu-docs/pulls/5","id":25183520,"html_url":"https://github.com/sulu-cmf/sulu-docs/pull/5","diff_url":"https://github.com/sulu-cmf/sulu-docs/pull/5.diff","patch_url":"https://github.com/sulu-cmf/sulu-docs/pull/5.patch","issue_url":"https://api.github.com/repos/sulu-cmf/sulu-docs/issues/5","number":5,"state":"open","locked":false,"title":"Developer book","user":{"login":"dantleech","id":530801,"avatar_url":"https://avatars.githubusercontent.com/u/530801?v=3","gravatar_id":"","url":"https://api.github.com/users/dantleech","html_url":"https://github.com/dantleech","followers_url":"https://api.github.com/users/dantleech/followers","following_url":"https://api.github.com/users/dantleech/following{/other_user}","gists_url":"https://api.github.com/users/dantleech/gists{/gist_id}","starred_url":"https://api.github.com/users/dantleech/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/dantleech/subscriptions","organizations_url":"https://api.github.com/users/dantleech/orgs","repos_url":"https://api.github.com/users/dantleech/repos","events_url":"https://api.github.com/users/dantleech/events{/privacy}","received_events_url":"https://api.github.com/users/dantleech/received_events","type":"User","site_admin":false},"body":"I think we should add a developer guide here. This would be a separate book, so there would be the User section (which I believe is what this currently is) and the Developer section.\r\n\r\nWe need this because developer documentation should be a first-class citizen and the quality of such a document should be important otherwise it will not be used.\r\n\r\nFor example I want to write a guide on how to write behat tests, standardize UI workflows (e.g. there should always be a success / error notification, delete buttons should always be here, etc.).\r\n\r\nDoing this in markdown in the existing `/docs` repository which is of variable quality does not really appeal to me and browsing such documents on GITHub isn't the best experience - RST provides a much richer medium for technical documentation and readthedocs provides a great reading experience.","created_at":"2014-11-28T08:48:28Z","updated_at":"2014-12-15T08:50:25Z","closed_at":null,"merged_at":null,"merge_commit_sha":"6bb778c9c4a19f02f77d2a5e36fb7ef792d3f898","assignee":null,"milestone":null,"commits_url":"https://api.github.com/repos/sulu-cmf/sulu-docs/pulls/5/commits","review_comments_url":"https://api.github.com/repos/sulu-cmf/sulu-docs/pulls/5/comments","review_comment_url":"https://api.github.com/repos/sulu-cmf/sulu-docs/pulls/comments/{number}","comments_url":"https://api.github.com/repos/sulu-cmf/sulu-docs/issues/5/comments","statuses_url":"https://api.github.com/repos/sulu-cmf/sulu-docs/statuses/ba48f45e669dbbebdf0938870957f1d302002700","head":{"label":"sulu-cmf:developer-book","ref":"developer-book","sha":"ba48f45e669dbbebdf0938870957f1d302002700","user":{"login":"sulu-cmf","id":5717006,"avatar_url":"https://avatars.githubusercontent.com/u/5717006?v=3","gravatar_id":"","url":"https://api.github.com/users/sulu-cmf","html_url":"https://github.com/sulu-cmf","followers_url":"https://api.github.com/users/sulu-cmf/followers","following_url":"https://api.github.com/users/sulu-cmf/following{/other_user}","gists_url":"https://api.github.com/users/sulu-cmf/gists{/gist_id}","starred_url":"https://api.github.com/users/sulu-cmf/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/sulu-cmf/subscriptions","organizations_url":"https://api.github.com/users/sulu-cmf/orgs","repos_url":"https://api.github.com/users/sulu-cmf/repos","events_url":"https://api.github.com/users/sulu-cmf/events{/privacy}","received_events_url":"https://api.github.com/users/sulu-cmf/received_events","type":"Organization","site_admin":false},"repo":{"id":22838344,"name":"sulu-docs","full_name":"sulu-cmf/sulu-docs","owner":{"login":"sulu-cmf","id":5717006,"avatar_url":"https://avatars.githubusercontent.com/u/5717006?v=3","gravatar_id":"","url":"https://api.github.com/users/sulu-cmf","html_url":"https://github.com/sulu-cmf","followers_url":"https://api.github.com/users/sulu-cmf/followers","following_url":"https://api.github.com/users/sulu-cmf/following{/other_user}","gists_url":"https://api.github.com/users/sulu-cmf/gists{/gist_id}","starred_url":"https://api.github.com/users/sulu-cmf/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/sulu-cmf/subscriptions","organizations_url":"https://api.github.com/users/sulu-cmf/orgs","repos_url":"https://api.github.com/users/sulu-cmf/repos","events_url":"https://api.github.com/users/sulu-cmf/events{/privacy}","received_events_url":"https://api.github.com/users/sulu-cmf/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/sulu-cmf/sulu-docs","description":"","fork":false,"url":"https://api.github.com/repos/sulu-cmf/sulu-docs","forks_url":"https://api.github.com/repos/sulu-cmf/sulu-docs/forks","keys_url":"https://api.github.com/repos/sulu-cmf/sulu-docs/keys{/key_id}","collaborators_url":"https://api.github.com/repos/sulu-cmf/sulu-docs/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/sulu-cmf/sulu-docs/teams","hooks_url":"https://api.github.com/repos/sulu-cmf/sulu-docs/hooks","issue_events_url":"https://api.github.com/repos/sulu-cmf/sulu-docs/issues/events{/number}","events_url":"https://api.github.com/repos/sulu-cmf/sulu-docs/events","assignees_url":"https://api.github.com/repos/sulu-cmf/sulu-docs/assignees{/user}","branches_url":"https://api.github.com/repos/sulu-cmf/sulu-docs/branches{/branch}","tags_url":"https://api.github.com/repos/sulu-cmf/sulu-docs/tags","blobs_url":"https://api.github.com/repos/sulu-cmf/sulu-docs/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/sulu-cmf/sulu-docs/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/sulu-cmf/sulu-docs/git/refs{/sha}","trees_url":"https://api.github.com/repos/sulu-cmf/sulu-docs/git/trees{/sha}","statuses_url":"https://api.github.com/repos/sulu-cmf/sulu-docs/statuses/{sha}","languages_url":"https://api.github.com/repos/sulu-cmf/sulu-docs/languages","stargazers_url":"https://api.github.com/repos/sulu-cmf/sulu-docs/stargazers","contributors_url":"https://api.github.com/repos/sulu-cmf/sulu-docs/contributors","subscribers_url":"https://api.github.com/repos/sulu-cmf/sulu-docs/subscribers","subscription_url":"https://api.github.com/repos/sulu-cmf/sulu-docs/subscription","commits_url":"https://api.github.com/repos/sulu-cmf/sulu-docs/commits{/sha}","git_commits_url":"https://api.github.com/repos/sulu-cmf/sulu-docs/git/commits{/sha}","comments_url":"https://api.github.com/repos/sulu-cmf/sulu-docs/comments{/number}","issue_comment_url":"https://api.github.com/repos/sulu-cmf/sulu-docs/issues/comments/{number}","contents_url":"https://api.github.com/repos/sulu-cmf/sulu-docs/contents/{+path}","compare_url":"https://api.github.com/repos/sulu-cmf/sulu-docs/compare/{base}...{head}","merges_url":"https://api.github.com/repos/sulu-cmf/sulu-docs/merges","archive_url":"https://api.github.com/repos/sulu-cmf/sulu-docs/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/sulu-cmf/sulu-docs/downloads","issues_url":"https://api.github.com/repos/sulu-cmf/sulu-docs/issues{/number}","pulls_url":"https://api.github.com/repos/sulu-cmf/sulu-docs/pulls{/number}","milestones_url":"https://api.github.com/repos/sulu-cmf/sulu-docs/milestones{/number}","notifications_url":"https://api.github.com/repos/sulu-cmf/sulu-docs/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/sulu-cmf/sulu-docs/labels{/name}","releases_url":"https://api.github.com/repos/sulu-cmf/sulu-docs/releases{/id}","created_at":"2014-08-11T12:31:16Z","updated_at":"2014-11-18T15:53:30Z","pushed_at":"2014-12-10T10:09:04Z","git_url":"git://github.com/sulu-cmf/sulu-docs.git","ssh_url":"git@github.com:sulu-cmf/sulu-docs.git","clone_url":"https://github.com/sulu-cmf/sulu-docs.git","svn_url":"https://github.com/sulu-cmf/sulu-docs","homepage":null,"size":560,"stargazers_count":0,"watchers_count":0,"language":"Python","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":0,"mirror_url":null,"open_issues_count":6,"forks":0,"open_issues":6,"watchers":0,"default_branch":"master"}},"base":{"label":"sulu-cmf:master","ref":"master","sha":"ad0eda6c66dc3a832bb15f6b13256fca2615fa6a","user":{"login":"sulu-cmf","id":5717006,"avatar_url":"https://avatars.githubusercontent.com/u/5717006?v=3","gravatar_id":"","url":"https://api.github.com/users/sulu-cmf","html_url":"https://github.com/sulu-cmf","followers_url":"https://api.github.com/users/sulu-cmf/followers","following_url":"https://api.github.com/users/sulu-cmf/following{/other_user}","gists_url":"https://api.github.com/users/sulu-cmf/gists{/gist_id}","starred_url":"https://api.github.com/users/sulu-cmf/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/sulu-cmf/subscriptions","organizations_url":"https://api.github.com/users/sulu-cmf/orgs","repos_url":"https://api.github.com/users/sulu-cmf/repos","events_url":"https://api.github.com/users/sulu-cmf/events{/privacy}","received_events_url":"https://api.github.com/users/sulu-cmf/received_events","type":"Organization","site_admin":false},"repo":{"id":22838344,"name":"sulu-docs","full_name":"sulu-cmf/sulu-docs","owner":{"login":"sulu-cmf","id":5717006,"avatar_url":"https://avatars.githubusercontent.com/u/5717006?v=3","gravatar_id":"","url":"https://api.github.com/users/sulu-cmf","html_url":"https://github.com/sulu-cmf","followers_url":"https://api.github.com/users/sulu-cmf/followers","following_url":"https://api.github.com/users/sulu-cmf/following{/other_user}","gists_url":"https://api.github.com/users/sulu-cmf/gists{/gist_id}","starred_url":"https://api.github.com/users/sulu-cmf/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/sulu-cmf/subscriptions","organizations_url":"https://api.github.com/users/sulu-cmf/orgs","repos_url":"https://api.github.com/users/sulu-cmf/repos","events_url":"https://api.github.com/users/sulu-cmf/events{/privacy}","received_events_url":"https://api.github.com/users/sulu-cmf/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/sulu-cmf/sulu-docs","description":"","fork":false,"url":"https://api.github.com/repos/sulu-cmf/sulu-docs","forks_url":"https://api.github.com/repos/sulu-cmf/sulu-docs/forks","keys_url":"https://api.github.com/repos/sulu-cmf/sulu-docs/keys{/key_id}","collaborators_url":"https://api.github.com/repos/sulu-cmf/sulu-docs/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/sulu-cmf/sulu-docs/teams","hooks_url":"https://api.github.com/repos/sulu-cmf/sulu-docs/hooks","issue_events_url":"https://api.github.com/repos/sulu-cmf/sulu-docs/issues/events{/number}","events_url":"https://api.github.com/repos/sulu-cmf/sulu-docs/events","assignees_url":"https://api.github.com/repos/sulu-cmf/sulu-docs/assignees{/user}","branches_url":"https://api.github.com/repos/sulu-cmf/sulu-docs/branches{/branch}","tags_url":"https://api.github.com/repos/sulu-cmf/sulu-docs/tags","blobs_url":"https://api.github.com/repos/sulu-cmf/sulu-docs/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/sulu-cmf/sulu-docs/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/sulu-cmf/sulu-docs/git/refs{/sha}","trees_url":"https://api.github.com/repos/sulu-cmf/sulu-docs/git/trees{/sha}","statuses_url":"https://api.github.com/repos/sulu-cmf/sulu-docs/statuses/{sha}","languages_url":"https://api.github.com/repos/sulu-cmf/sulu-docs/languages","stargazers_url":"https://api.github.com/repos/sulu-cmf/sulu-docs/stargazers","contributors_url":"https://api.github.com/repos/sulu-cmf/sulu-docs/contributors","subscribers_url":"https://api.github.com/repos/sulu-cmf/sulu-docs/subscribers","subscription_url":"https://api.github.com/repos/sulu-cmf/sulu-docs/subscription","commits_url":"https://api.github.com/repos/sulu-cmf/sulu-docs/commits{/sha}","git_commits_url":"https://api.github.com/repos/sulu-cmf/sulu-docs/git/commits{/sha}","comments_url":"https://api.github.com/repos/sulu-cmf/sulu-docs/comments{/number}","issue_comment_url":"https://api.github.com/repos/sulu-cmf/sulu-docs/issues/comments/{number}","contents_url":"https://api.github.com/repos/sulu-cmf/sulu-docs/contents/{+path}","compare_url":"https://api.github.com/repos/sulu-cmf/sulu-docs/compare/{base}...{head}","merges_url":"https://api.github.com/repos/sulu-cmf/sulu-docs/merges","archive_url":"https://api.github.com/repos/sulu-cmf/sulu-docs/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/sulu-cmf/sulu-docs/downloads","issues_url":"https://api.github.com/repos/sulu-cmf/sulu-docs/issues{/number}","pulls_url":"https://api.github.com/repos/sulu-cmf/sulu-docs/pulls{/number}","milestones_url":"https://api.github.com/repos/sulu-cmf/sulu-docs/milestones{/number}","notifications_url":"https://api.github.com/repos/sulu-cmf/sulu-docs/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/sulu-cmf/sulu-docs/labels{/name}","releases_url":"https://api.github.com/repos/sulu-cmf/sulu-docs/releases{/id}","created_at":"2014-08-11T12:31:16Z","updated_at":"2014-11-18T15:53:30Z","pushed_at":"2014-12-10T10:09:04Z","git_url":"git://github.com/sulu-cmf/sulu-docs.git","ssh_url":"git@github.com:sulu-cmf/sulu-docs.git","clone_url":"https://github.com/sulu-cmf/sulu-docs.git","svn_url":"https://github.com/sulu-cmf/sulu-docs","homepage":null,"size":560,"stargazers_count":0,"watchers_count":0,"language":"Python","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":0,"mirror_url":null,"open_issues_count":6,"forks":0,"open_issues":6,"watchers":0,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/sulu-cmf/sulu-docs/pulls/5"},"html":{"href":"https://github.com/sulu-cmf/sulu-docs/pull/5"},"issue":{"href":"https://api.github.com/repos/sulu-cmf/sulu-docs/issues/5"},"comments":{"href":"https://api.github.com/repos/sulu-cmf/sulu-docs/issues/5/comments"},"review_comments":{"href":"https://api.github.com/repos/sulu-cmf/sulu-docs/pulls/5/comments"},"review_comment":{"href":"https://api.github.com/repos/sulu-cmf/sulu-docs/pulls/comments/{number}"},"commits":{"href":"https://api.github.com/repos/sulu-cmf/sulu-docs/pulls/5/commits"},"statuses":{"href":"https://api.github.com/repos/sulu-cmf/sulu-docs/statuses/ba48f45e669dbbebdf0938870957f1d302002700"}}}}