{"action":"opened","number":1031,"pull_request":{"url":"https://api.github.com/repos/apache/zeppelin/pulls/1031","id":74190661,"html_url":"https://github.com/apache/zeppelin/pull/1031","diff_url":"https://github.com/apache/zeppelin/pull/1031.diff","patch_url":"https://github.com/apache/zeppelin/pull/1031.patch","issue_url":"https://api.github.com/repos/apache/zeppelin/issues/1031","number":1031,"state":"open","locked":false,"title":"[ZEPPELIN-1018] Apply auto \"Table of Contents\" generator to Zeppelin docs website","user":{"login":"AhyoungRyu","id":10060731,"avatar_url":"https://avatars.githubusercontent.com/u/10060731?v=3","gravatar_id":"","url":"https://api.github.com/users/AhyoungRyu","html_url":"https://github.com/AhyoungRyu","followers_url":"https://api.github.com/users/AhyoungRyu/followers","following_url":"https://api.github.com/users/AhyoungRyu/following{/other_user}","gists_url":"https://api.github.com/users/AhyoungRyu/gists{/gist_id}","starred_url":"https://api.github.com/users/AhyoungRyu/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/AhyoungRyu/subscriptions","organizations_url":"https://api.github.com/users/AhyoungRyu/orgs","repos_url":"https://api.github.com/users/AhyoungRyu/repos","events_url":"https://api.github.com/users/AhyoungRyu/events{/privacy}","received_events_url":"https://api.github.com/users/AhyoungRyu/received_events","type":"User","site_admin":false},"body":"### What is this PR for?\r\nI added auto TOC(Table of Contents) generator for Zeppelin documentation website. TOC can help people looking through whole contents at a glance and finding what they want quickly. \r\n\r\nI just added `<div id=\"toc\"></div>`  to the each documentation header. [`toc`](https://github.com/apache/zeppelin/compare/master...AhyoungRyu:ZEPPELIN-1018?expand=1#diff-85af09fb498a5667ea455391533f945dR3)  recognize `<h2>` & `<h3>` as a title in the docs  and it automatically generate TOC. So I set a rule for this work. (I'll write this rule on `docs/CONTRIBUTING.md` or [docs/howtocontributewebsite](https://zeppelin.apache.org/docs/0.6.0-SNAPSHOT/development/howtocontributewebsite.html)). \r\n\r\n```\r\n# Level-1 Heading  <- Use only for the main title of the page\r\n## Level-2 Heading <- Start with this one\r\n### Level-3 heading <- Only use this one for child of Level-2\r\n\r\ntoc only recognize Level-2 & Level-3\r\n```\r\n\r\nPlease see the below attached screenshot image.\r\n\r\n### What type of PR is it?\r\nImprovement & Documentation\r\n\r\n### Todos\r\n* [x] - Add TOC generator\r\n* [x] - Apply TOC(`<div id=\"toc\"></div>`) to every documentation and reorganize each headers(apply the above rule)\r\n* [x] - Fix some broken code block in several docs\r\n* [ ] - Apply TOC to `r.md` (Currently R docs has some duplicated info since [this one](https://github.com/apache/zeppelin/commit/d5e87fb8ba98f08db5b0a4995104ce19f182c678) and [this one](https://github.com/apache/zeppelin/commit/7d6cc7e99154e2d337c11fdf8be1a874ed3e9ada) )\r\n* [ ] - Apply TOC to `install.md` after #1010 merged\r\n\r\n### What is the Jira issue?\r\n[ZEPPELIN-1018](https://issues.apache.org/jira/browse/ZEPPELIN-1018)\r\n\r\n### How should this be tested?\r\n1. Apply this patch and build `docs/` with [this guide](https://github.com/apache/zeppelin/tree/master/docs#build-documentation)\r\n2.  Visit some docs page. Then you can see TOC in the header of page. \r\n\r\n### Screenshots (if appropriate)\r\n - Automatically generated TOC in Spark interpreter docs page\r\n<img width=\"831\" alt=\"screen shot 2016-06-16 at 9 37 18 pm\" src=\"https://cloud.githubusercontent.com/assets/10060731/16140902/945b9c7a-340a-11e6-91f3-b6174738bed0.png\">\r\n\r\n\r\n### Questions:\r\n* Does the licenses files need update? \r\nNo. Actually I used [jekyll-table-of-contents#copyright](https://github.com/ghiculescu/jekyll-table-of-contents#copyright). But I don't need to add a license for this :)\r\n* Is there breaking changes for older versions? No\r\n* Does this needs documentation? Maybe","created_at":"2016-06-17T05:29:46Z","updated_at":"2016-06-17T05:29:46Z","closed_at":null,"merged_at":null,"merge_commit_sha":null,"assignee":null,"milestone":null,"commits_url":"https://api.github.com/repos/apache/zeppelin/pulls/1031/commits","review_comments_url":"https://api.github.com/repos/apache/zeppelin/pulls/1031/comments","review_comment_url":"https://api.github.com/repos/apache/zeppelin/pulls/comments{/number}","comments_url":"https://api.github.com/repos/apache/zeppelin/issues/1031/comments","statuses_url":"https://api.github.com/repos/apache/zeppelin/statuses/0315d5c3901d54ba3ce85401665a6a2f4f42799f","head":{"label":"AhyoungRyu:ZEPPELIN-1018","ref":"ZEPPELIN-1018","sha":"0315d5c3901d54ba3ce85401665a6a2f4f42799f","user":{"login":"AhyoungRyu","id":10060731,"avatar_url":"https://avatars.githubusercontent.com/u/10060731?v=3","gravatar_id":"","url":"https://api.github.com/users/AhyoungRyu","html_url":"https://github.com/AhyoungRyu","followers_url":"https://api.github.com/users/AhyoungRyu/followers","following_url":"https://api.github.com/users/AhyoungRyu/following{/other_user}","gists_url":"https://api.github.com/users/AhyoungRyu/gists{/gist_id}","starred_url":"https://api.github.com/users/AhyoungRyu/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/AhyoungRyu/subscriptions","organizations_url":"https://api.github.com/users/AhyoungRyu/orgs","repos_url":"https://api.github.com/users/AhyoungRyu/repos","events_url":"https://api.github.com/users/AhyoungRyu/events{/privacy}","received_events_url":"https://api.github.com/users/AhyoungRyu/received_events","type":"User","site_admin":false},"repo":{"id":44792338,"name":"incubator-zeppelin","full_name":"AhyoungRyu/incubator-zeppelin","owner":{"login":"AhyoungRyu","id":10060731,"avatar_url":"https://avatars.githubusercontent.com/u/10060731?v=3","gravatar_id":"","url":"https://api.github.com/users/AhyoungRyu","html_url":"https://github.com/AhyoungRyu","followers_url":"https://api.github.com/users/AhyoungRyu/followers","following_url":"https://api.github.com/users/AhyoungRyu/following{/other_user}","gists_url":"https://api.github.com/users/AhyoungRyu/gists{/gist_id}","starred_url":"https://api.github.com/users/AhyoungRyu/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/AhyoungRyu/subscriptions","organizations_url":"https://api.github.com/users/AhyoungRyu/orgs","repos_url":"https://api.github.com/users/AhyoungRyu/repos","events_url":"https://api.github.com/users/AhyoungRyu/events{/privacy}","received_events_url":"https://api.github.com/users/AhyoungRyu/received_events","type":"User","site_admin":false},"private":false,"html_url":"https://github.com/AhyoungRyu/incubator-zeppelin","description":"Mirror of Apache Zeppelin (Incubating)","fork":true,"url":"https://api.github.com/repos/AhyoungRyu/incubator-zeppelin","forks_url":"https://api.github.com/repos/AhyoungRyu/incubator-zeppelin/forks","keys_url":"https://api.github.com/repos/AhyoungRyu/incubator-zeppelin/keys{/key_id}","collaborators_url":"https://api.github.com/repos/AhyoungRyu/incubator-zeppelin/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/AhyoungRyu/incubator-zeppelin/teams","hooks_url":"https://api.github.com/repos/AhyoungRyu/incubator-zeppelin/hooks","issue_events_url":"https://api.github.com/repos/AhyoungRyu/incubator-zeppelin/issues/events{/number}","events_url":"https://api.github.com/repos/AhyoungRyu/incubator-zeppelin/events","assignees_url":"https://api.github.com/repos/AhyoungRyu/incubator-zeppelin/assignees{/user}","branches_url":"https://api.github.com/repos/AhyoungRyu/incubator-zeppelin/branches{/branch}","tags_url":"https://api.github.com/repos/AhyoungRyu/incubator-zeppelin/tags","blobs_url":"https://api.github.com/repos/AhyoungRyu/incubator-zeppelin/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/AhyoungRyu/incubator-zeppelin/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/AhyoungRyu/incubator-zeppelin/git/refs{/sha}","trees_url":"https://api.github.com/repos/AhyoungRyu/incubator-zeppelin/git/trees{/sha}","statuses_url":"https://api.github.com/repos/AhyoungRyu/incubator-zeppelin/statuses/{sha}","languages_url":"https://api.github.com/repos/AhyoungRyu/incubator-zeppelin/languages","stargazers_url":"https://api.github.com/repos/AhyoungRyu/incubator-zeppelin/stargazers","contributors_url":"https://api.github.com/repos/AhyoungRyu/incubator-zeppelin/contributors","subscribers_url":"https://api.github.com/repos/AhyoungRyu/incubator-zeppelin/subscribers","subscription_url":"https://api.github.com/repos/AhyoungRyu/incubator-zeppelin/subscription","commits_url":"https://api.github.com/repos/AhyoungRyu/incubator-zeppelin/commits{/sha}","git_commits_url":"https://api.github.com/repos/AhyoungRyu/incubator-zeppelin/git/commits{/sha}","comments_url":"https://api.github.com/repos/AhyoungRyu/incubator-zeppelin/comments{/number}","issue_comment_url":"https://api.github.com/repos/AhyoungRyu/incubator-zeppelin/issues/comments{/number}","contents_url":"https://api.github.com/repos/AhyoungRyu/incubator-zeppelin/contents/{+path}","compare_url":"https://api.github.com/repos/AhyoungRyu/incubator-zeppelin/compare/{base}...{head}","merges_url":"https://api.github.com/repos/AhyoungRyu/incubator-zeppelin/merges","archive_url":"https://api.github.com/repos/AhyoungRyu/incubator-zeppelin/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/AhyoungRyu/incubator-zeppelin/downloads","issues_url":"https://api.github.com/repos/AhyoungRyu/incubator-zeppelin/issues{/number}","pulls_url":"https://api.github.com/repos/AhyoungRyu/incubator-zeppelin/pulls{/number}","milestones_url":"https://api.github.com/repos/AhyoungRyu/incubator-zeppelin/milestones{/number}","notifications_url":"https://api.github.com/repos/AhyoungRyu/incubator-zeppelin/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/AhyoungRyu/incubator-zeppelin/labels{/name}","releases_url":"https://api.github.com/repos/AhyoungRyu/incubator-zeppelin/releases{/id}","deployments_url":"https://api.github.com/repos/AhyoungRyu/incubator-zeppelin/deployments","created_at":"2015-10-23T05:19:13Z","updated_at":"2015-10-23T05:19:16Z","pushed_at":"2016-06-17T02:45:21Z","git_url":"git://github.com/AhyoungRyu/incubator-zeppelin.git","ssh_url":"git@github.com:AhyoungRyu/incubator-zeppelin.git","clone_url":"https://github.com/AhyoungRyu/incubator-zeppelin.git","svn_url":"https://github.com/AhyoungRyu/incubator-zeppelin","homepage":null,"size":29270,"stargazers_count":0,"watchers_count":0,"language":"Java","has_issues":false,"has_downloads":true,"has_wiki":false,"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":"apache:master","ref":"master","sha":"f786d1387a7ccae0387e470abb44912d5f322d6b","user":{"login":"apache","id":47359,"avatar_url":"https://avatars.githubusercontent.com/u/47359?v=3","gravatar_id":"","url":"https://api.github.com/users/apache","html_url":"https://github.com/apache","followers_url":"https://api.github.com/users/apache/followers","following_url":"https://api.github.com/users/apache/following{/other_user}","gists_url":"https://api.github.com/users/apache/gists{/gist_id}","starred_url":"https://api.github.com/users/apache/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/apache/subscriptions","organizations_url":"https://api.github.com/users/apache/orgs","repos_url":"https://api.github.com/users/apache/repos","events_url":"https://api.github.com/users/apache/events{/privacy}","received_events_url":"https://api.github.com/users/apache/received_events","type":"Organization","site_admin":false},"repo":{"id":32848140,"name":"zeppelin","full_name":"apache/zeppelin","owner":{"login":"apache","id":47359,"avatar_url":"https://avatars.githubusercontent.com/u/47359?v=3","gravatar_id":"","url":"https://api.github.com/users/apache","html_url":"https://github.com/apache","followers_url":"https://api.github.com/users/apache/followers","following_url":"https://api.github.com/users/apache/following{/other_user}","gists_url":"https://api.github.com/users/apache/gists{/gist_id}","starred_url":"https://api.github.com/users/apache/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/apache/subscriptions","organizations_url":"https://api.github.com/users/apache/orgs","repos_url":"https://api.github.com/users/apache/repos","events_url":"https://api.github.com/users/apache/events{/privacy}","received_events_url":"https://api.github.com/users/apache/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/apache/zeppelin","description":"Mirror of Apache Zeppelin","fork":false,"url":"https://api.github.com/repos/apache/zeppelin","forks_url":"https://api.github.com/repos/apache/zeppelin/forks","keys_url":"https://api.github.com/repos/apache/zeppelin/keys{/key_id}","collaborators_url":"https://api.github.com/repos/apache/zeppelin/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/apache/zeppelin/teams","hooks_url":"https://api.github.com/repos/apache/zeppelin/hooks","issue_events_url":"https://api.github.com/repos/apache/zeppelin/issues/events{/number}","events_url":"https://api.github.com/repos/apache/zeppelin/events","assignees_url":"https://api.github.com/repos/apache/zeppelin/assignees{/user}","branches_url":"https://api.github.com/repos/apache/zeppelin/branches{/branch}","tags_url":"https://api.github.com/repos/apache/zeppelin/tags","blobs_url":"https://api.github.com/repos/apache/zeppelin/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/apache/zeppelin/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/apache/zeppelin/git/refs{/sha}","trees_url":"https://api.github.com/repos/apache/zeppelin/git/trees{/sha}","statuses_url":"https://api.github.com/repos/apache/zeppelin/statuses/{sha}","languages_url":"https://api.github.com/repos/apache/zeppelin/languages","stargazers_url":"https://api.github.com/repos/apache/zeppelin/stargazers","contributors_url":"https://api.github.com/repos/apache/zeppelin/contributors","subscribers_url":"https://api.github.com/repos/apache/zeppelin/subscribers","subscription_url":"https://api.github.com/repos/apache/zeppelin/subscription","commits_url":"https://api.github.com/repos/apache/zeppelin/commits{/sha}","git_commits_url":"https://api.github.com/repos/apache/zeppelin/git/commits{/sha}","comments_url":"https://api.github.com/repos/apache/zeppelin/comments{/number}","issue_comment_url":"https://api.github.com/repos/apache/zeppelin/issues/comments{/number}","contents_url":"https://api.github.com/repos/apache/zeppelin/contents/{+path}","compare_url":"https://api.github.com/repos/apache/zeppelin/compare/{base}...{head}","merges_url":"https://api.github.com/repos/apache/zeppelin/merges","archive_url":"https://api.github.com/repos/apache/zeppelin/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/apache/zeppelin/downloads","issues_url":"https://api.github.com/repos/apache/zeppelin/issues{/number}","pulls_url":"https://api.github.com/repos/apache/zeppelin/pulls{/number}","milestones_url":"https://api.github.com/repos/apache/zeppelin/milestones{/number}","notifications_url":"https://api.github.com/repos/apache/zeppelin/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/apache/zeppelin/labels{/name}","releases_url":"https://api.github.com/repos/apache/zeppelin/releases{/id}","deployments_url":"https://api.github.com/repos/apache/zeppelin/deployments","created_at":"2015-03-25T07:00:06Z","updated_at":"2016-06-17T05:18:14Z","pushed_at":"2016-06-17T05:29:46Z","git_url":"git://github.com/apache/zeppelin.git","ssh_url":"git@github.com:apache/zeppelin.git","clone_url":"https://github.com/apache/zeppelin.git","svn_url":"https://github.com/apache/zeppelin","homepage":"","size":105364,"stargazers_count":1573,"watchers_count":1573,"language":"Java","has_issues":false,"has_downloads":true,"has_wiki":false,"has_pages":true,"forks_count":800,"mirror_url":"git://git.apache.org/incubator-zeppelin.git","open_issues_count":107,"forks":800,"open_issues":107,"watchers":1573,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/apache/zeppelin/pulls/1031"},"html":{"href":"https://github.com/apache/zeppelin/pull/1031"},"issue":{"href":"https://api.github.com/repos/apache/zeppelin/issues/1031"},"comments":{"href":"https://api.github.com/repos/apache/zeppelin/issues/1031/comments"},"review_comments":{"href":"https://api.github.com/repos/apache/zeppelin/pulls/1031/comments"},"review_comment":{"href":"https://api.github.com/repos/apache/zeppelin/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/apache/zeppelin/pulls/1031/commits"},"statuses":{"href":"https://api.github.com/repos/apache/zeppelin/statuses/0315d5c3901d54ba3ce85401665a6a2f4f42799f"}},"merged":false,"mergeable":false,"mergeable_state":"dirty","merged_by":null,"comments":0,"review_comments":0,"commits":12,"additions":651,"deletions":438,"changed_files":44}}
{"actor":{"display_login":"AhyoungRyu"}}