{"action":"created","comment":{"url":"https://api.github.com/repos/cfpb/regulations-bootstrap/pulls/comments/29229562","id":29229562,"diff_hunk":"@@ -1,20 +1,109 @@\n-### Native Install\n+# regulations-bootstrap\n \n-1. First, ensure you have virtualenv-wrapper installed: (`pip install virtualenv-wrapper`)\n-2. Run `./regs_bootstrap.sh` to clone directories and install dependencies\n+[eRegulations](http://cfpb.github.io/eRegulations) is a web-based tool that makes regulations easier to find, read and understand with features such as inline official interpretations, highlighted defined terms, and a revision comparison view.\n \n+eRegs is made up of three core components:\n \n-### Vagrant Install\n-1. `brew cask install vagrant`\n-2. `vagrant up` to create and provision the VM\n-3. `vagrant ssh` to connect to the running VM\n-4. `cp /vagrant/regs_bootstrap.sh regs_bootstrap.sh && ./regs_bootstrap.sh` to clone directories and install dependencies\n-5. Continue from step 3 above.\n+* [regulations-parser](https://github.com/cfpb/regulations-parser): Parse regulations\n+* [regulations-core](https://github.com/cfpb/regulations-core): Regulations API\n+* [regulations-site](https://github.com/cfpb/regulations-site): Display the regulations\n+\n+This repository contains scripts that boostrap a coherent eRegulations working envionrment, either locally or in a [Vagrant](https://www.vagrantup.com/) virtual machine.\n+\n+## Bootstrap Locally\n+\n+To bootstrap a local (i.e. not virtualized) eRegs environment, you'll\n+need to install Python's virtualenv and virtualenvwrapper. \n+\n+### Requirements\n+\n+Install [virtualenv](https://virtualenv.pypa.io/en/latest/):\n+\n+```shell\n+pip install virtualenv\n+```\n+\n+Then install and configure \n+[virtualenvwrapper](https://virtualenvwrapper.readthedocs.org/en/latest/). \n+More information on how virtualenvwrapper works and how you may wish to \n+set it up in your shell can be found in the \n+[virtualenvwrapper documentation](https://virtualenvwrapper.readthedocs.org/en/latest/install.html).\n+\n+```shell\n+pip install virtualenvwrapper\n+export WORKON_HOME=~/envs\n+mkdir -p $WORKON_HOME\n+source `which virtualenvwrapper.sh`\n+```\n+\n+### Bootstrapping\n+\n+Once you have these requirements installed you can run the\n+`regs_bootstrap.sh`:\n+\n+```shell\n+./regs_bootstrap.sh\n+```\n+\n+This will clone all of the eRegs repositories, make seperate virtualenvs \n+for them, and setup their dependencies.\n+\n+## Bootstrap with Vagrant\n+\n+To bootstrap eRegs in a [Vagrant](https://www.vagrantup.com/) virtual \n+machine, you'll need to install Vagrant locally. Everything else should \n+be taken care of by this repository's `Vagrantfile`.\n+\n+### Requirements\n+\n+Install [Vagrant](https://www.vagrantup.com/). On Mac OS X, this can be\n+done with [Homebrew](http://brew.sh):\n+\n+```shell\n+brew install vagrant\n+```\n+\n+### Bootstrapping\n+\n+The eRegs bootstrapping process will be performed as part of the Vagrant\n+provisioning process. All one needs to do is provision the Vagrant\n+virtual machine. \n+\n+```shell\n+vagrant up\n+```\n+\n+Once the virtual machine is running, you should be able to access\n+regulations-core at [http://localhost:8000](http://localhost:8000) and \n+regulations-site at [http://localhost:8001](http://localhost:8001).\n+\n+You can also connect to the virtual machine via SSH.\n+\n+```shell\n+vagrant ssh\n+```\n+\n+## Using","path":"README.md","position":95,"original_position":95,"commit_id":"c2366387aef671fbac20998f4f6ba23d10814371","original_commit_id":"c2366387aef671fbac20998f4f6ba23d10814371","user":{"login":"ascott1","id":212533,"avatar_url":"https://avatars.githubusercontent.com/u/212533?v=3","gravatar_id":"","url":"https://api.github.com/users/ascott1","html_url":"https://github.com/ascott1","followers_url":"https://api.github.com/users/ascott1/followers","following_url":"https://api.github.com/users/ascott1/following{/other_user}","gists_url":"https://api.github.com/users/ascott1/gists{/gist_id}","starred_url":"https://api.github.com/users/ascott1/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/ascott1/subscriptions","organizations_url":"https://api.github.com/users/ascott1/orgs","repos_url":"https://api.github.com/users/ascott1/repos","events_url":"https://api.github.com/users/ascott1/events{/privacy}","received_events_url":"https://api.github.com/users/ascott1/received_events","type":"User","site_admin":false},"body":"It shouldn't hold up merging this, but should we give instructions for running the parser locally as well?","created_at":"2015-04-28T10:12:33Z","updated_at":"2015-04-28T10:12:33Z","html_url":"https://github.com/cfpb/regulations-bootstrap/pull/1#discussion_r29229562","pull_request_url":"https://api.github.com/repos/cfpb/regulations-bootstrap/pulls/1","_links":{"self":{"href":"https://api.github.com/repos/cfpb/regulations-bootstrap/pulls/comments/29229562"},"html":{"href":"https://github.com/cfpb/regulations-bootstrap/pull/1#discussion_r29229562"},"pull_request":{"href":"https://api.github.com/repos/cfpb/regulations-bootstrap/pulls/1"}}},"pull_request":{"url":"https://api.github.com/repos/cfpb/regulations-bootstrap/pulls/1","id":34218972,"html_url":"https://github.com/cfpb/regulations-bootstrap/pull/1","diff_url":"https://github.com/cfpb/regulations-bootstrap/pull/1.diff","patch_url":"https://github.com/cfpb/regulations-bootstrap/pull/1.patch","issue_url":"https://api.github.com/repos/cfpb/regulations-bootstrap/issues/1","number":1,"state":"open","locked":false,"title":"Bootstrap eRegs for CFPB","user":{"login":"willbarton","id":10562538,"avatar_url":"https://avatars.githubusercontent.com/u/10562538?v=3","gravatar_id":"","url":"https://api.github.com/users/willbarton","html_url":"https://github.com/willbarton","followers_url":"https://api.github.com/users/willbarton/followers","following_url":"https://api.github.com/users/willbarton/following{/other_user}","gists_url":"https://api.github.com/users/willbarton/gists{/gist_id}","starred_url":"https://api.github.com/users/willbarton/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/willbarton/subscriptions","organizations_url":"https://api.github.com/users/willbarton/orgs","repos_url":"https://api.github.com/users/willbarton/repos","events_url":"https://api.github.com/users/willbarton/events{/privacy}","received_events_url":"https://api.github.com/users/willbarton/received_events","type":"User","site_admin":false},"body":"This PR updates regulations-bootstrap for CFPB use, adds some additional nicety to the Vagrant setup (automatically runs the `reg_bootstrap.sh` and adds a `startup.sh` to start the reg-core and reg-site services).\r\n\r\n## Additions\r\n\r\n- `startup.sh` to start regulations-core and regulations-site when the virtual machine starts. \r\n\r\n## Changes\r\n\r\n- Changed `regs_bootstrap.sh` for the CFPB\r\n- Changed `bootstrap.sh` to run `regs_bootstrap.sh` during provisioning.\r\n- Changed the assumption above where the regulations repository checkouts will be stored. `bootstrap.sh` will run `regs_bootstrap.sh` on the `/vagrant` directory so that the checkouts will be accessible from the host system.\r\n- Changed `README.md` to include more detail and more CFPB-specificity.\r\n\r\n## Review\r\n\r\n- @ascott1 \r\n- @grapesmoker ","created_at":"2015-04-27T22:58:24Z","updated_at":"2015-04-28T10:12:33Z","closed_at":null,"merged_at":null,"merge_commit_sha":"0fe4d00d765a3aef8da5dcb2f32b0b1f578e3350","assignee":null,"milestone":null,"commits_url":"https://api.github.com/repos/cfpb/regulations-bootstrap/pulls/1/commits","review_comments_url":"https://api.github.com/repos/cfpb/regulations-bootstrap/pulls/1/comments","review_comment_url":"https://api.github.com/repos/cfpb/regulations-bootstrap/pulls/comments{/number}","comments_url":"https://api.github.com/repos/cfpb/regulations-bootstrap/issues/1/comments","statuses_url":"https://api.github.com/repos/cfpb/regulations-bootstrap/statuses/c2366387aef671fbac20998f4f6ba23d10814371","head":{"label":"willbarton:master","ref":"master","sha":"c2366387aef671fbac20998f4f6ba23d10814371","user":{"login":"willbarton","id":10562538,"avatar_url":"https://avatars.githubusercontent.com/u/10562538?v=3","gravatar_id":"","url":"https://api.github.com/users/willbarton","html_url":"https://github.com/willbarton","followers_url":"https://api.github.com/users/willbarton/followers","following_url":"https://api.github.com/users/willbarton/following{/other_user}","gists_url":"https://api.github.com/users/willbarton/gists{/gist_id}","starred_url":"https://api.github.com/users/willbarton/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/willbarton/subscriptions","organizations_url":"https://api.github.com/users/willbarton/orgs","repos_url":"https://api.github.com/users/willbarton/repos","events_url":"https://api.github.com/users/willbarton/events{/privacy}","received_events_url":"https://api.github.com/users/willbarton/received_events","type":"User","site_admin":false},"repo":{"id":34530239,"name":"regulations-bootstrap","full_name":"willbarton/regulations-bootstrap","owner":{"login":"willbarton","id":10562538,"avatar_url":"https://avatars.githubusercontent.com/u/10562538?v=3","gravatar_id":"","url":"https://api.github.com/users/willbarton","html_url":"https://github.com/willbarton","followers_url":"https://api.github.com/users/willbarton/followers","following_url":"https://api.github.com/users/willbarton/following{/other_user}","gists_url":"https://api.github.com/users/willbarton/gists{/gist_id}","starred_url":"https://api.github.com/users/willbarton/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/willbarton/subscriptions","organizations_url":"https://api.github.com/users/willbarton/orgs","repos_url":"https://api.github.com/users/willbarton/repos","events_url":"https://api.github.com/users/willbarton/events{/privacy}","received_events_url":"https://api.github.com/users/willbarton/received_events","type":"User","site_admin":false},"private":false,"html_url":"https://github.com/willbarton/regulations-bootstrap","description":"Work towards a bootstrap for getting a full eRegs dev environment set up.","fork":true,"url":"https://api.github.com/repos/willbarton/regulations-bootstrap","forks_url":"https://api.github.com/repos/willbarton/regulations-bootstrap/forks","keys_url":"https://api.github.com/repos/willbarton/regulations-bootstrap/keys{/key_id}","collaborators_url":"https://api.github.com/repos/willbarton/regulations-bootstrap/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/willbarton/regulations-bootstrap/teams","hooks_url":"https://api.github.com/repos/willbarton/regulations-bootstrap/hooks","issue_events_url":"https://api.github.com/repos/willbarton/regulations-bootstrap/issues/events{/number}","events_url":"https://api.github.com/repos/willbarton/regulations-bootstrap/events","assignees_url":"https://api.github.com/repos/willbarton/regulations-bootstrap/assignees{/user}","branches_url":"https://api.github.com/repos/willbarton/regulations-bootstrap/branches{/branch}","tags_url":"https://api.github.com/repos/willbarton/regulations-bootstrap/tags","blobs_url":"https://api.github.com/repos/willbarton/regulations-bootstrap/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/willbarton/regulations-bootstrap/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/willbarton/regulations-bootstrap/git/refs{/sha}","trees_url":"https://api.github.com/repos/willbarton/regulations-bootstrap/git/trees{/sha}","statuses_url":"https://api.github.com/repos/willbarton/regulations-bootstrap/statuses/{sha}","languages_url":"https://api.github.com/repos/willbarton/regulations-bootstrap/languages","stargazers_url":"https://api.github.com/repos/willbarton/regulations-bootstrap/stargazers","contributors_url":"https://api.github.com/repos/willbarton/regulations-bootstrap/contributors","subscribers_url":"https://api.github.com/repos/willbarton/regulations-bootstrap/subscribers","subscription_url":"https://api.github.com/repos/willbarton/regulations-bootstrap/subscription","commits_url":"https://api.github.com/repos/willbarton/regulations-bootstrap/commits{/sha}","git_commits_url":"https://api.github.com/repos/willbarton/regulations-bootstrap/git/commits{/sha}","comments_url":"https://api.github.com/repos/willbarton/regulations-bootstrap/comments{/number}","issue_comment_url":"https://api.github.com/repos/willbarton/regulations-bootstrap/issues/comments{/number}","contents_url":"https://api.github.com/repos/willbarton/regulations-bootstrap/contents/{+path}","compare_url":"https://api.github.com/repos/willbarton/regulations-bootstrap/compare/{base}...{head}","merges_url":"https://api.github.com/repos/willbarton/regulations-bootstrap/merges","archive_url":"https://api.github.com/repos/willbarton/regulations-bootstrap/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/willbarton/regulations-bootstrap/downloads","issues_url":"https://api.github.com/repos/willbarton/regulations-bootstrap/issues{/number}","pulls_url":"https://api.github.com/repos/willbarton/regulations-bootstrap/pulls{/number}","milestones_url":"https://api.github.com/repos/willbarton/regulations-bootstrap/milestones{/number}","notifications_url":"https://api.github.com/repos/willbarton/regulations-bootstrap/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/willbarton/regulations-bootstrap/labels{/name}","releases_url":"https://api.github.com/repos/willbarton/regulations-bootstrap/releases{/id}","created_at":"2015-04-24T16:45:45Z","updated_at":"2015-04-27T22:50:12Z","pushed_at":"2015-04-27T22:50:12Z","git_url":"git://github.com/willbarton/regulations-bootstrap.git","ssh_url":"git@github.com:willbarton/regulations-bootstrap.git","clone_url":"https://github.com/willbarton/regulations-bootstrap.git","svn_url":"https://github.com/willbarton/regulations-bootstrap","homepage":null,"size":85,"stargazers_count":0,"watchers_count":0,"language":"Shell","has_issues":false,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":0,"mirror_url":null,"open_issues_count":0,"forks":0,"open_issues":0,"watchers":0,"default_branch":"master"}},"base":{"label":"cfpb:master","ref":"master","sha":"4fd6abd2edfe94ca138c11d031066173e48e7ab0","user":{"login":"cfpb","id":1071563,"avatar_url":"https://avatars.githubusercontent.com/u/1071563?v=3","gravatar_id":"","url":"https://api.github.com/users/cfpb","html_url":"https://github.com/cfpb","followers_url":"https://api.github.com/users/cfpb/followers","following_url":"https://api.github.com/users/cfpb/following{/other_user}","gists_url":"https://api.github.com/users/cfpb/gists{/gist_id}","starred_url":"https://api.github.com/users/cfpb/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/cfpb/subscriptions","organizations_url":"https://api.github.com/users/cfpb/orgs","repos_url":"https://api.github.com/users/cfpb/repos","events_url":"https://api.github.com/users/cfpb/events{/privacy}","received_events_url":"https://api.github.com/users/cfpb/received_events","type":"Organization","site_admin":false},"repo":{"id":34471296,"name":"regulations-bootstrap","full_name":"cfpb/regulations-bootstrap","owner":{"login":"cfpb","id":1071563,"avatar_url":"https://avatars.githubusercontent.com/u/1071563?v=3","gravatar_id":"","url":"https://api.github.com/users/cfpb","html_url":"https://github.com/cfpb","followers_url":"https://api.github.com/users/cfpb/followers","following_url":"https://api.github.com/users/cfpb/following{/other_user}","gists_url":"https://api.github.com/users/cfpb/gists{/gist_id}","starred_url":"https://api.github.com/users/cfpb/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/cfpb/subscriptions","organizations_url":"https://api.github.com/users/cfpb/orgs","repos_url":"https://api.github.com/users/cfpb/repos","events_url":"https://api.github.com/users/cfpb/events{/privacy}","received_events_url":"https://api.github.com/users/cfpb/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/cfpb/regulations-bootstrap","description":"Work towards a bootstrap for getting a full eRegs dev environment set up.","fork":true,"url":"https://api.github.com/repos/cfpb/regulations-bootstrap","forks_url":"https://api.github.com/repos/cfpb/regulations-bootstrap/forks","keys_url":"https://api.github.com/repos/cfpb/regulations-bootstrap/keys{/key_id}","collaborators_url":"https://api.github.com/repos/cfpb/regulations-bootstrap/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/cfpb/regulations-bootstrap/teams","hooks_url":"https://api.github.com/repos/cfpb/regulations-bootstrap/hooks","issue_events_url":"https://api.github.com/repos/cfpb/regulations-bootstrap/issues/events{/number}","events_url":"https://api.github.com/repos/cfpb/regulations-bootstrap/events","assignees_url":"https://api.github.com/repos/cfpb/regulations-bootstrap/assignees{/user}","branches_url":"https://api.github.com/repos/cfpb/regulations-bootstrap/branches{/branch}","tags_url":"https://api.github.com/repos/cfpb/regulations-bootstrap/tags","blobs_url":"https://api.github.com/repos/cfpb/regulations-bootstrap/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/cfpb/regulations-bootstrap/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/cfpb/regulations-bootstrap/git/refs{/sha}","trees_url":"https://api.github.com/repos/cfpb/regulations-bootstrap/git/trees{/sha}","statuses_url":"https://api.github.com/repos/cfpb/regulations-bootstrap/statuses/{sha}","languages_url":"https://api.github.com/repos/cfpb/regulations-bootstrap/languages","stargazers_url":"https://api.github.com/repos/cfpb/regulations-bootstrap/stargazers","contributors_url":"https://api.github.com/repos/cfpb/regulations-bootstrap/contributors","subscribers_url":"https://api.github.com/repos/cfpb/regulations-bootstrap/subscribers","subscription_url":"https://api.github.com/repos/cfpb/regulations-bootstrap/subscription","commits_url":"https://api.github.com/repos/cfpb/regulations-bootstrap/commits{/sha}","git_commits_url":"https://api.github.com/repos/cfpb/regulations-bootstrap/git/commits{/sha}","comments_url":"https://api.github.com/repos/cfpb/regulations-bootstrap/comments{/number}","issue_comment_url":"https://api.github.com/repos/cfpb/regulations-bootstrap/issues/comments{/number}","contents_url":"https://api.github.com/repos/cfpb/regulations-bootstrap/contents/{+path}","compare_url":"https://api.github.com/repos/cfpb/regulations-bootstrap/compare/{base}...{head}","merges_url":"https://api.github.com/repos/cfpb/regulations-bootstrap/merges","archive_url":"https://api.github.com/repos/cfpb/regulations-bootstrap/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/cfpb/regulations-bootstrap/downloads","issues_url":"https://api.github.com/repos/cfpb/regulations-bootstrap/issues{/number}","pulls_url":"https://api.github.com/repos/cfpb/regulations-bootstrap/pulls{/number}","milestones_url":"https://api.github.com/repos/cfpb/regulations-bootstrap/milestones{/number}","notifications_url":"https://api.github.com/repos/cfpb/regulations-bootstrap/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/cfpb/regulations-bootstrap/labels{/name}","releases_url":"https://api.github.com/repos/cfpb/regulations-bootstrap/releases{/id}","created_at":"2015-04-23T17:31:33Z","updated_at":"2015-04-23T17:32:14Z","pushed_at":"2015-04-27T22:58:24Z","git_url":"git://github.com/cfpb/regulations-bootstrap.git","ssh_url":"git@github.com:cfpb/regulations-bootstrap.git","clone_url":"https://github.com/cfpb/regulations-bootstrap.git","svn_url":"https://github.com/cfpb/regulations-bootstrap","homepage":null,"size":128,"stargazers_count":0,"watchers_count":0,"language":"Shell","has_issues":false,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":2,"mirror_url":null,"open_issues_count":1,"forks":2,"open_issues":1,"watchers":0,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/cfpb/regulations-bootstrap/pulls/1"},"html":{"href":"https://github.com/cfpb/regulations-bootstrap/pull/1"},"issue":{"href":"https://api.github.com/repos/cfpb/regulations-bootstrap/issues/1"},"comments":{"href":"https://api.github.com/repos/cfpb/regulations-bootstrap/issues/1/comments"},"review_comments":{"href":"https://api.github.com/repos/cfpb/regulations-bootstrap/pulls/1/comments"},"review_comment":{"href":"https://api.github.com/repos/cfpb/regulations-bootstrap/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/cfpb/regulations-bootstrap/pulls/1/commits"},"statuses":{"href":"https://api.github.com/repos/cfpb/regulations-bootstrap/statuses/c2366387aef671fbac20998f4f6ba23d10814371"}}}}