{"action":"created","comment":{"url":"https://api.github.com/repos/locationtech-labs/geopyspark/pulls/comments/189591597","pull_request_review_id":121799669,"id":189591597,"diff_hunk":"@@ -172,21 +141,11 @@ Note:\n   If you have altered the global behavior of ``sbt`` this install may\n   not work the way it was intended.\n \n-Installing For Developers\n-===========================\n-\n-.. code:: console\n-\n-   make build\n-   pip install -e .\n-\n-``make build`` will assemble the back-end ``jar`` and move it the ``jars``\n-sub-package. The second command will install GeoPySpark in \"editable\" mode.\n-Meaning any changes to the source files will also appear in your system\n-installation.\n-\n Installing to a Virtual Environment\n-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n+\n+TODO: Ask Jake if he's seen issues with this. I had no problem using the standard pip installation\n+instructions in a virtualenv. If no problems, perhaps we remove for now.","path":"README.rst","position":169,"original_position":169,"commit_id":"1ba9d118ce9859fb105bbd32d071ac172c3199d4","original_commit_id":"1ba9d118ce9859fb105bbd32d071ac172c3199d4","user":{"login":"jpolchlo","id":18410961,"avatar_url":"https://avatars1.githubusercontent.com/u/18410961?v=4","gravatar_id":"","url":"https://api.github.com/users/jpolchlo","html_url":"https://github.com/jpolchlo","followers_url":"https://api.github.com/users/jpolchlo/followers","following_url":"https://api.github.com/users/jpolchlo/following{/other_user}","gists_url":"https://api.github.com/users/jpolchlo/gists{/gist_id}","starred_url":"https://api.github.com/users/jpolchlo/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/jpolchlo/subscriptions","organizations_url":"https://api.github.com/users/jpolchlo/orgs","repos_url":"https://api.github.com/users/jpolchlo/repos","events_url":"https://api.github.com/users/jpolchlo/events{/privacy}","received_events_url":"https://api.github.com/users/jpolchlo/received_events","type":"User","site_admin":false},"body":"Yeah, interesting.  I'll clarify that I ran into my troubles when installing from source as well.\r\n\r\n¯\\_(ツ)_/¯","created_at":"2018-05-21T13:40:06Z","updated_at":"2018-05-21T13:40:13Z","html_url":"https://github.com/locationtech-labs/geopyspark/pull/657#discussion_r189591597","pull_request_url":"https://api.github.com/repos/locationtech-labs/geopyspark/pulls/657","author_association":"COLLABORATOR","_links":{"self":{"href":"https://api.github.com/repos/locationtech-labs/geopyspark/pulls/comments/189591597"},"html":{"href":"https://github.com/locationtech-labs/geopyspark/pull/657#discussion_r189591597"},"pull_request":{"href":"https://api.github.com/repos/locationtech-labs/geopyspark/pulls/657"}},"in_reply_to_id":189281663},"pull_request":{"url":"https://api.github.com/repos/locationtech-labs/geopyspark/pulls/657","id":188466929,"html_url":"https://github.com/locationtech-labs/geopyspark/pull/657","diff_url":"https://github.com/locationtech-labs/geopyspark/pull/657.diff","patch_url":"https://github.com/locationtech-labs/geopyspark/pull/657.patch","issue_url":"https://api.github.com/repos/locationtech-labs/geopyspark/issues/657","number":657,"state":"open","locked":false,"title":"WIP: README cleanup / improvements","user":{"login":"CloudNiner","id":1818302,"avatar_url":"https://avatars0.githubusercontent.com/u/1818302?v=4","gravatar_id":"","url":"https://api.github.com/users/CloudNiner","html_url":"https://github.com/CloudNiner","followers_url":"https://api.github.com/users/CloudNiner/followers","following_url":"https://api.github.com/users/CloudNiner/following{/other_user}","gists_url":"https://api.github.com/users/CloudNiner/gists{/gist_id}","starred_url":"https://api.github.com/users/CloudNiner/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/CloudNiner/subscriptions","organizations_url":"https://api.github.com/users/CloudNiner/orgs","repos_url":"https://api.github.com/users/CloudNiner/repos","events_url":"https://api.github.com/users/CloudNiner/events{/privacy}","received_events_url":"https://api.github.com/users/CloudNiner/received_events","type":"User","site_admin":false},"body":"## Overview\r\n\r\nThis PR attempts to restructure the project README according to the following goals:\r\n- Clarify the requirements and installation setup for new users\r\n  - Simplify installation notes by providing only two user install options, either pip or from source, which is pretty standard across python projects\r\n- Improve documentation for GPS developers\r\n  - By grouping all information related to development into a single top level heading, rather than spread across multiple top-level headings, e.g. dev installation instructions in the installation section, which should generally be focused on user installations.\r\n- Improve access to ReadTheDocs documentation\r\n\r\nThis PR should be considered a first draft effort. There are a few TODOs that I'd like to get input from @jbouffard about, and the sections could be restructured if we think the above goals could be met in other ways.\r\n\r\nThe diff is pretty messy, it's likely best to review the changes by looking at the rendered view of the new document.\r\n\r\n## Notes\r\n\r\nThis PR also updates the build instructions in the Contributing docs to reference the README, since those appeared to be out of date.\r\n\r\nI don't feel strongly about keeping the Example at the very top. Some projects do this, others start with Requirements + Installation and then show the Example. I suppose Example should stay at top if we primarily want to highlight the project's utility, otherwise swap if we think the utility is clear enough from a short intro/descriptive sentence that we can jump right to setup instructions, pushing the example down.\r\n\r\nI signed the Eclipse CLA and commits appear verified, so I believe I have all the contributing prereqs done. Hopefully I didn't miss anything, LMK if I need to address anything else for that.\r\n\r\n","created_at":"2018-05-16T15:11:41Z","updated_at":"2018-05-21T13:40:13Z","closed_at":null,"merged_at":null,"merge_commit_sha":"e71cc933dea285f083841ddf884e1ca01fe4e48f","assignee":null,"assignees":[],"requested_reviewers":[],"requested_teams":[],"labels":[],"milestone":null,"commits_url":"https://api.github.com/repos/locationtech-labs/geopyspark/pulls/657/commits","review_comments_url":"https://api.github.com/repos/locationtech-labs/geopyspark/pulls/657/comments","review_comment_url":"https://api.github.com/repos/locationtech-labs/geopyspark/pulls/comments{/number}","comments_url":"https://api.github.com/repos/locationtech-labs/geopyspark/issues/657/comments","statuses_url":"https://api.github.com/repos/locationtech-labs/geopyspark/statuses/1ba9d118ce9859fb105bbd32d071ac172c3199d4","head":{"label":"CloudNiner:feature/awf/documentation-getting-started-improvements","ref":"feature/awf/documentation-getting-started-improvements","sha":"1ba9d118ce9859fb105bbd32d071ac172c3199d4","user":{"login":"CloudNiner","id":1818302,"avatar_url":"https://avatars0.githubusercontent.com/u/1818302?v=4","gravatar_id":"","url":"https://api.github.com/users/CloudNiner","html_url":"https://github.com/CloudNiner","followers_url":"https://api.github.com/users/CloudNiner/followers","following_url":"https://api.github.com/users/CloudNiner/following{/other_user}","gists_url":"https://api.github.com/users/CloudNiner/gists{/gist_id}","starred_url":"https://api.github.com/users/CloudNiner/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/CloudNiner/subscriptions","organizations_url":"https://api.github.com/users/CloudNiner/orgs","repos_url":"https://api.github.com/users/CloudNiner/repos","events_url":"https://api.github.com/users/CloudNiner/events{/privacy}","received_events_url":"https://api.github.com/users/CloudNiner/received_events","type":"User","site_admin":false},"repo":{"id":133367684,"name":"geopyspark","full_name":"CloudNiner/geopyspark","owner":{"login":"CloudNiner","id":1818302,"avatar_url":"https://avatars0.githubusercontent.com/u/1818302?v=4","gravatar_id":"","url":"https://api.github.com/users/CloudNiner","html_url":"https://github.com/CloudNiner","followers_url":"https://api.github.com/users/CloudNiner/followers","following_url":"https://api.github.com/users/CloudNiner/following{/other_user}","gists_url":"https://api.github.com/users/CloudNiner/gists{/gist_id}","starred_url":"https://api.github.com/users/CloudNiner/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/CloudNiner/subscriptions","organizations_url":"https://api.github.com/users/CloudNiner/orgs","repos_url":"https://api.github.com/users/CloudNiner/repos","events_url":"https://api.github.com/users/CloudNiner/events{/privacy}","received_events_url":"https://api.github.com/users/CloudNiner/received_events","type":"User","site_admin":false},"private":false,"html_url":"https://github.com/CloudNiner/geopyspark","description":"GeoTrellis for PySpark","fork":true,"url":"https://api.github.com/repos/CloudNiner/geopyspark","forks_url":"https://api.github.com/repos/CloudNiner/geopyspark/forks","keys_url":"https://api.github.com/repos/CloudNiner/geopyspark/keys{/key_id}","collaborators_url":"https://api.github.com/repos/CloudNiner/geopyspark/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/CloudNiner/geopyspark/teams","hooks_url":"https://api.github.com/repos/CloudNiner/geopyspark/hooks","issue_events_url":"https://api.github.com/repos/CloudNiner/geopyspark/issues/events{/number}","events_url":"https://api.github.com/repos/CloudNiner/geopyspark/events","assignees_url":"https://api.github.com/repos/CloudNiner/geopyspark/assignees{/user}","branches_url":"https://api.github.com/repos/CloudNiner/geopyspark/branches{/branch}","tags_url":"https://api.github.com/repos/CloudNiner/geopyspark/tags","blobs_url":"https://api.github.com/repos/CloudNiner/geopyspark/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/CloudNiner/geopyspark/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/CloudNiner/geopyspark/git/refs{/sha}","trees_url":"https://api.github.com/repos/CloudNiner/geopyspark/git/trees{/sha}","statuses_url":"https://api.github.com/repos/CloudNiner/geopyspark/statuses/{sha}","languages_url":"https://api.github.com/repos/CloudNiner/geopyspark/languages","stargazers_url":"https://api.github.com/repos/CloudNiner/geopyspark/stargazers","contributors_url":"https://api.github.com/repos/CloudNiner/geopyspark/contributors","subscribers_url":"https://api.github.com/repos/CloudNiner/geopyspark/subscribers","subscription_url":"https://api.github.com/repos/CloudNiner/geopyspark/subscription","commits_url":"https://api.github.com/repos/CloudNiner/geopyspark/commits{/sha}","git_commits_url":"https://api.github.com/repos/CloudNiner/geopyspark/git/commits{/sha}","comments_url":"https://api.github.com/repos/CloudNiner/geopyspark/comments{/number}","issue_comment_url":"https://api.github.com/repos/CloudNiner/geopyspark/issues/comments{/number}","contents_url":"https://api.github.com/repos/CloudNiner/geopyspark/contents/{+path}","compare_url":"https://api.github.com/repos/CloudNiner/geopyspark/compare/{base}...{head}","merges_url":"https://api.github.com/repos/CloudNiner/geopyspark/merges","archive_url":"https://api.github.com/repos/CloudNiner/geopyspark/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/CloudNiner/geopyspark/downloads","issues_url":"https://api.github.com/repos/CloudNiner/geopyspark/issues{/number}","pulls_url":"https://api.github.com/repos/CloudNiner/geopyspark/pulls{/number}","milestones_url":"https://api.github.com/repos/CloudNiner/geopyspark/milestones{/number}","notifications_url":"https://api.github.com/repos/CloudNiner/geopyspark/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/CloudNiner/geopyspark/labels{/name}","releases_url":"https://api.github.com/repos/CloudNiner/geopyspark/releases{/id}","deployments_url":"https://api.github.com/repos/CloudNiner/geopyspark/deployments","created_at":"2018-05-14T13:49:11Z","updated_at":"2018-05-14T13:49:14Z","pushed_at":"2018-05-21T12:42:56Z","git_url":"git://github.com/CloudNiner/geopyspark.git","ssh_url":"git@github.com:CloudNiner/geopyspark.git","clone_url":"https://github.com/CloudNiner/geopyspark.git","svn_url":"https://github.com/CloudNiner/geopyspark","homepage":"","size":27831,"stargazers_count":0,"watchers_count":0,"language":"Python","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":"other","name":"Other","spdx_id":null,"url":null},"forks":0,"open_issues":0,"watchers":0,"default_branch":"master"}},"base":{"label":"locationtech-labs:master","ref":"master","sha":"b421d61e7a06cd443cec63a69eda3f45d423b0f4","user":{"login":"locationtech-labs","id":24686045,"avatar_url":"https://avatars3.githubusercontent.com/u/24686045?v=4","gravatar_id":"","url":"https://api.github.com/users/locationtech-labs","html_url":"https://github.com/locationtech-labs","followers_url":"https://api.github.com/users/locationtech-labs/followers","following_url":"https://api.github.com/users/locationtech-labs/following{/other_user}","gists_url":"https://api.github.com/users/locationtech-labs/gists{/gist_id}","starred_url":"https://api.github.com/users/locationtech-labs/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/locationtech-labs/subscriptions","organizations_url":"https://api.github.com/users/locationtech-labs/orgs","repos_url":"https://api.github.com/users/locationtech-labs/repos","events_url":"https://api.github.com/users/locationtech-labs/events{/privacy}","received_events_url":"https://api.github.com/users/locationtech-labs/received_events","type":"Organization","site_admin":false},"repo":{"id":76568965,"name":"geopyspark","full_name":"locationtech-labs/geopyspark","owner":{"login":"locationtech-labs","id":24686045,"avatar_url":"https://avatars3.githubusercontent.com/u/24686045?v=4","gravatar_id":"","url":"https://api.github.com/users/locationtech-labs","html_url":"https://github.com/locationtech-labs","followers_url":"https://api.github.com/users/locationtech-labs/followers","following_url":"https://api.github.com/users/locationtech-labs/following{/other_user}","gists_url":"https://api.github.com/users/locationtech-labs/gists{/gist_id}","starred_url":"https://api.github.com/users/locationtech-labs/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/locationtech-labs/subscriptions","organizations_url":"https://api.github.com/users/locationtech-labs/orgs","repos_url":"https://api.github.com/users/locationtech-labs/repos","events_url":"https://api.github.com/users/locationtech-labs/events{/privacy}","received_events_url":"https://api.github.com/users/locationtech-labs/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/locationtech-labs/geopyspark","description":"GeoTrellis for PySpark","fork":false,"url":"https://api.github.com/repos/locationtech-labs/geopyspark","forks_url":"https://api.github.com/repos/locationtech-labs/geopyspark/forks","keys_url":"https://api.github.com/repos/locationtech-labs/geopyspark/keys{/key_id}","collaborators_url":"https://api.github.com/repos/locationtech-labs/geopyspark/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/locationtech-labs/geopyspark/teams","hooks_url":"https://api.github.com/repos/locationtech-labs/geopyspark/hooks","issue_events_url":"https://api.github.com/repos/locationtech-labs/geopyspark/issues/events{/number}","events_url":"https://api.github.com/repos/locationtech-labs/geopyspark/events","assignees_url":"https://api.github.com/repos/locationtech-labs/geopyspark/assignees{/user}","branches_url":"https://api.github.com/repos/locationtech-labs/geopyspark/branches{/branch}","tags_url":"https://api.github.com/repos/locationtech-labs/geopyspark/tags","blobs_url":"https://api.github.com/repos/locationtech-labs/geopyspark/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/locationtech-labs/geopyspark/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/locationtech-labs/geopyspark/git/refs{/sha}","trees_url":"https://api.github.com/repos/locationtech-labs/geopyspark/git/trees{/sha}","statuses_url":"https://api.github.com/repos/locationtech-labs/geopyspark/statuses/{sha}","languages_url":"https://api.github.com/repos/locationtech-labs/geopyspark/languages","stargazers_url":"https://api.github.com/repos/locationtech-labs/geopyspark/stargazers","contributors_url":"https://api.github.com/repos/locationtech-labs/geopyspark/contributors","subscribers_url":"https://api.github.com/repos/locationtech-labs/geopyspark/subscribers","subscription_url":"https://api.github.com/repos/locationtech-labs/geopyspark/subscription","commits_url":"https://api.github.com/repos/locationtech-labs/geopyspark/commits{/sha}","git_commits_url":"https://api.github.com/repos/locationtech-labs/geopyspark/git/commits{/sha}","comments_url":"https://api.github.com/repos/locationtech-labs/geopyspark/comments{/number}","issue_comment_url":"https://api.github.com/repos/locationtech-labs/geopyspark/issues/comments{/number}","contents_url":"https://api.github.com/repos/locationtech-labs/geopyspark/contents/{+path}","compare_url":"https://api.github.com/repos/locationtech-labs/geopyspark/compare/{base}...{head}","merges_url":"https://api.github.com/repos/locationtech-labs/geopyspark/merges","archive_url":"https://api.github.com/repos/locationtech-labs/geopyspark/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/locationtech-labs/geopyspark/downloads","issues_url":"https://api.github.com/repos/locationtech-labs/geopyspark/issues{/number}","pulls_url":"https://api.github.com/repos/locationtech-labs/geopyspark/pulls{/number}","milestones_url":"https://api.github.com/repos/locationtech-labs/geopyspark/milestones{/number}","notifications_url":"https://api.github.com/repos/locationtech-labs/geopyspark/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/locationtech-labs/geopyspark/labels{/name}","releases_url":"https://api.github.com/repos/locationtech-labs/geopyspark/releases{/id}","deployments_url":"https://api.github.com/repos/locationtech-labs/geopyspark/deployments","created_at":"2016-12-15T14:55:48Z","updated_at":"2018-05-15T11:41:22Z","pushed_at":"2018-05-21T12:43:09Z","git_url":"git://github.com/locationtech-labs/geopyspark.git","ssh_url":"git@github.com:locationtech-labs/geopyspark.git","clone_url":"https://github.com/locationtech-labs/geopyspark.git","svn_url":"https://github.com/locationtech-labs/geopyspark","homepage":"","size":27830,"stargazers_count":81,"watchers_count":81,"language":"Python","has_issues":true,"has_projects":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":22,"mirror_url":null,"archived":false,"open_issues_count":28,"license":{"key":"other","name":"Other","spdx_id":null,"url":null},"forks":22,"open_issues":28,"watchers":81,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/locationtech-labs/geopyspark/pulls/657"},"html":{"href":"https://github.com/locationtech-labs/geopyspark/pull/657"},"issue":{"href":"https://api.github.com/repos/locationtech-labs/geopyspark/issues/657"},"comments":{"href":"https://api.github.com/repos/locationtech-labs/geopyspark/issues/657/comments"},"review_comments":{"href":"https://api.github.com/repos/locationtech-labs/geopyspark/pulls/657/comments"},"review_comment":{"href":"https://api.github.com/repos/locationtech-labs/geopyspark/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/locationtech-labs/geopyspark/pulls/657/commits"},"statuses":{"href":"https://api.github.com/repos/locationtech-labs/geopyspark/statuses/1ba9d118ce9859fb105bbd32d071ac172c3199d4"}},"author_association":"NONE"}}
{"actor":{"display_login":"jpolchlo"}}