From 2bf0db14c682a873473b3d9676a669ddea650b51 Mon Sep 17 00:00:00 2001 From: Vinoth Chandar Date: Fri, 30 Dec 2016 11:05:22 -0800 Subject: [PATCH] Adding docs folder, with skeleton jekyll based site - Uses https://github.com/tomjohnson1492/documentation-theme-jekyll - Have filler pages --- docs/.gitignore | 4 + docs/404.md | 6 + docs/Dockerfile | 26 + docs/Gemfile | 10 + docs/Gemfile.lock | 150 + docs/_config.yml | 87 + docs/_data/alerts.yml | 15 + docs/_data/sidebars/mydoc_sidebar.yml | 58 + docs/_data/strings.yml | 5 + docs/_data/tags.yml | 9 + docs/_data/topnav.yml | 30 + docs/_includes/archive.html | 15 + docs/_includes/callout.html | 1 + .../custom/getting_started_series.html | 19 + .../custom/getting_started_series_next.html | 10 + docs/_includes/custom/series_acme.html | 19 + docs/_includes/custom/series_acme_next.html | 30 + docs/_includes/custom/sidebarconfigs.html | 19 + docs/_includes/custom/usermap.html | 14 + docs/_includes/custom/usermapcomplex.html | 91 + docs/_includes/disqus.html | 16 + docs/_includes/feedback.html | 13 + docs/_includes/footer.html | 9 + docs/_includes/google_analytics.html | 6 + docs/_includes/head.html | 36 + docs/_includes/head_print.html | 33 + docs/_includes/image.html | 1 + docs/_includes/important.html | 1 + docs/_includes/initialize_shuffle.html | 130 + docs/_includes/inline_image.html | 1 + docs/_includes/links.html | 44 + docs/_includes/note.html | 1 + docs/_includes/sidebar.html | 56 + docs/_includes/taglogic.html | 32 + docs/_includes/tip.html | 1 + docs/_includes/toc.html | 21 + docs/_includes/topnav.html | 75 + docs/_includes/warning.html | 1 + docs/_layouts/default.html | 80 + docs/_layouts/default_print.html | 25 + docs/_layouts/none.html | 3 + docs/_layouts/page.html | 70 + docs/_layouts/page_print.html | 15 + docs/_layouts/post.html | 41 + docs/_posts/2016-12-30-strata-talk-2017.md | 11 + docs/admin_guide.md | 10 + docs/api_docs.md | 10 + docs/code_structure.md | 10 + docs/community.md | 10 + docs/comparison.md | 10 + docs/concepts.md | 10 + docs/css/bootstrap.min.css | 5 + docs/css/customstyles.css | 1181 ++++ docs/css/font-awesome.min.css | 4 + docs/css/fonts/FontAwesome.otf | Bin 0 -> 93888 bytes docs/css/fonts/fontawesome-webfont.eot | Bin 0 -> 60767 bytes docs/css/fonts/fontawesome-webfont.svg | 565 ++ docs/css/fonts/fontawesome-webfont.ttf | Bin 0 -> 122092 bytes docs/css/fonts/fontawesome-webfont.woff | Bin 0 -> 71508 bytes docs/css/fonts/fontawesome-webfont.woff2 | Bin 0 -> 56780 bytes docs/css/lavish-bootstrap.css | 5898 +++++++++++++++++ docs/css/modern-business.css | 93 + docs/css/printstyles.css | 160 + docs/css/syntax.css | 60 + docs/css/theme-blue.css | 103 + docs/css/theme-green.css | 99 + docs/dev_setup.md | 10 + docs/feed.xml | 32 + docs/fonts/FontAwesome.otf | Bin 0 -> 85908 bytes docs/fonts/fontawesome-webfont.eot | Bin 0 -> 56006 bytes docs/fonts/fontawesome-webfont.svg | 520 ++ docs/fonts/fontawesome-webfont.ttf | Bin 0 -> 112160 bytes docs/fonts/fontawesome-webfont.woff | Bin 0 -> 65452 bytes docs/fonts/glyphicons-halflings-regular.eot | Bin 0 -> 20127 bytes docs/fonts/glyphicons-halflings-regular.svg | 288 + docs/fonts/glyphicons-halflings-regular.ttf | Bin 0 -> 45404 bytes docs/fonts/glyphicons-halflings-regular.woff | Bin 0 -> 23424 bytes docs/fonts/glyphicons-halflings-regular.woff2 | Bin 0 -> 18028 bytes docs/images/androidsdkmanagericon.png | Bin 0 -> 795 bytes docs/images/authorizegithubscreen2.png | Bin 0 -> 76388 bytes docs/images/authorizeongithub.png | Bin 0 -> 22571 bytes docs/images/company_logo.png | Bin 0 -> 3105 bytes docs/images/company_logo_big.png | Bin 0 -> 9588 bytes docs/images/favicon.ico | Bin 0 -> 177352 bytes docs/images/helpapi-01.png | Bin 0 -> 91640 bytes docs/images/helpapi.svg | 1661 +++++ docs/images/illustratoroptions.png | Bin 0 -> 118175 bytes docs/images/itermexample.png | Bin 0 -> 68886 bytes docs/images/jekyll.png | Bin 0 -> 5375 bytes docs/images/killalljekyll.png | Bin 0 -> 66686 bytes docs/images/liningup.png | Bin 0 -> 74728 bytes docs/images/workflowarrow.png | Bin 0 -> 3595 bytes docs/incremental_processing.md | 10 + docs/index.md | 220 + docs/js/customscripts.js | 55 + docs/js/jekyll-search.js | 1 + docs/js/jquery.ba-throttle-debounce.min.js | 9 + docs/js/jquery.localScroll.min.js | 7 + docs/js/jquery.navgoco.min.js | 8 + docs/js/jquery.scrollTo.min.js | 7 + docs/js/jquery.shuffle.min.js | 1588 +++++ docs/js/mydoc_scroll.html | 240 + docs/js/toc.js | 82 + docs/licenses/LICENSE | 21 + docs/licenses/LICENSE-BSD-NAVGOCO.txt | 27 + docs/pages/news/news.html | 32 + docs/pages/news/news_archive.html | 41 + docs/performance.md | 10 + docs/powered_by.md | 9 + docs/quickstart.md | 10 + docs/roadmap.md | 10 + docs/search.json | 33 + docs/sitemap.xml | 24 + docs/sql_queries.md | 10 + docs/use_cases.md | 9 + 115 files changed, 14542 insertions(+) create mode 100644 docs/.gitignore create mode 100644 docs/404.md create mode 100644 docs/Dockerfile create mode 100644 docs/Gemfile create mode 100644 docs/Gemfile.lock create mode 100644 docs/_config.yml create mode 100644 docs/_data/alerts.yml create mode 100644 docs/_data/sidebars/mydoc_sidebar.yml create mode 100644 docs/_data/strings.yml create mode 100644 docs/_data/tags.yml create mode 100644 docs/_data/topnav.yml create mode 100644 docs/_includes/archive.html create mode 100644 docs/_includes/callout.html create mode 100644 docs/_includes/custom/getting_started_series.html create mode 100644 docs/_includes/custom/getting_started_series_next.html create mode 100644 docs/_includes/custom/series_acme.html create mode 100644 docs/_includes/custom/series_acme_next.html create mode 100644 docs/_includes/custom/sidebarconfigs.html create mode 100644 docs/_includes/custom/usermap.html create mode 100644 docs/_includes/custom/usermapcomplex.html create mode 100644 docs/_includes/disqus.html create mode 100644 docs/_includes/feedback.html create mode 100755 docs/_includes/footer.html create mode 100644 docs/_includes/google_analytics.html create mode 100644 docs/_includes/head.html create mode 100644 docs/_includes/head_print.html create mode 100644 docs/_includes/image.html create mode 100644 docs/_includes/important.html create mode 100644 docs/_includes/initialize_shuffle.html create mode 100644 docs/_includes/inline_image.html create mode 100644 docs/_includes/links.html create mode 100644 docs/_includes/note.html create mode 100644 docs/_includes/sidebar.html create mode 100644 docs/_includes/taglogic.html create mode 100644 docs/_includes/tip.html create mode 100644 docs/_includes/toc.html create mode 100644 docs/_includes/topnav.html create mode 100644 docs/_includes/warning.html create mode 100644 docs/_layouts/default.html create mode 100644 docs/_layouts/default_print.html create mode 100644 docs/_layouts/none.html create mode 100644 docs/_layouts/page.html create mode 100644 docs/_layouts/page_print.html create mode 100644 docs/_layouts/post.html create mode 100644 docs/_posts/2016-12-30-strata-talk-2017.md create mode 100644 docs/admin_guide.md create mode 100644 docs/api_docs.md create mode 100644 docs/code_structure.md create mode 100644 docs/community.md create mode 100644 docs/comparison.md create mode 100644 docs/concepts.md create mode 100755 docs/css/bootstrap.min.css create mode 100644 docs/css/customstyles.css create mode 100644 docs/css/font-awesome.min.css create mode 100644 docs/css/fonts/FontAwesome.otf create mode 100644 docs/css/fonts/fontawesome-webfont.eot create mode 100644 docs/css/fonts/fontawesome-webfont.svg create mode 100644 docs/css/fonts/fontawesome-webfont.ttf create mode 100644 docs/css/fonts/fontawesome-webfont.woff create mode 100644 docs/css/fonts/fontawesome-webfont.woff2 create mode 100644 docs/css/lavish-bootstrap.css create mode 100755 docs/css/modern-business.css create mode 100644 docs/css/printstyles.css create mode 100644 docs/css/syntax.css create mode 100644 docs/css/theme-blue.css create mode 100644 docs/css/theme-green.css create mode 100644 docs/dev_setup.md create mode 100644 docs/feed.xml create mode 100644 docs/fonts/FontAwesome.otf create mode 100644 docs/fonts/fontawesome-webfont.eot create mode 100644 docs/fonts/fontawesome-webfont.svg create mode 100644 docs/fonts/fontawesome-webfont.ttf create mode 100644 docs/fonts/fontawesome-webfont.woff create mode 100644 docs/fonts/glyphicons-halflings-regular.eot create mode 100644 docs/fonts/glyphicons-halflings-regular.svg create mode 100644 docs/fonts/glyphicons-halflings-regular.ttf create mode 100644 docs/fonts/glyphicons-halflings-regular.woff create mode 100644 docs/fonts/glyphicons-halflings-regular.woff2 create mode 100644 docs/images/androidsdkmanagericon.png create mode 100644 docs/images/authorizegithubscreen2.png create mode 100644 docs/images/authorizeongithub.png create mode 100644 docs/images/company_logo.png create mode 100644 docs/images/company_logo_big.png create mode 100644 docs/images/favicon.ico create mode 100644 docs/images/helpapi-01.png create mode 100644 docs/images/helpapi.svg create mode 100644 docs/images/illustratoroptions.png create mode 100644 docs/images/itermexample.png create mode 100644 docs/images/jekyll.png create mode 100644 docs/images/killalljekyll.png create mode 100644 docs/images/liningup.png create mode 100644 docs/images/workflowarrow.png create mode 100644 docs/incremental_processing.md create mode 100644 docs/index.md create mode 100644 docs/js/customscripts.js create mode 100644 docs/js/jekyll-search.js create mode 100644 docs/js/jquery.ba-throttle-debounce.min.js create mode 100644 docs/js/jquery.localScroll.min.js create mode 100755 docs/js/jquery.navgoco.min.js create mode 100644 docs/js/jquery.scrollTo.min.js create mode 100644 docs/js/jquery.shuffle.min.js create mode 100644 docs/js/mydoc_scroll.html create mode 100644 docs/js/toc.js create mode 100644 docs/licenses/LICENSE create mode 100644 docs/licenses/LICENSE-BSD-NAVGOCO.txt create mode 100644 docs/pages/news/news.html create mode 100644 docs/pages/news/news_archive.html create mode 100644 docs/performance.md create mode 100644 docs/powered_by.md create mode 100644 docs/quickstart.md create mode 100644 docs/roadmap.md create mode 100644 docs/search.json create mode 100644 docs/sitemap.xml create mode 100644 docs/sql_queries.md create mode 100644 docs/use_cases.md diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 000000000..f380cae1b --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1,4 @@ +_site +.sass-cache +.jekyll-metadata +.ruby-version diff --git a/docs/404.md b/docs/404.md new file mode 100644 index 000000000..a7b58c002 --- /dev/null +++ b/docs/404.md @@ -0,0 +1,6 @@ +--- +title: "Page Not Found" +search: exclude +--- + +Sorry, but the page you were trying to view does not exist. Try searching for it or looking at the URL to see if it looks correct. diff --git a/docs/Dockerfile b/docs/Dockerfile new file mode 100644 index 000000000..b1fa52c47 --- /dev/null +++ b/docs/Dockerfile @@ -0,0 +1,26 @@ +FROM ruby:2.1 +MAINTAINER mrafayaleem@gmail.com + +RUN apt-get clean \ + && mv /var/lib/apt/lists /var/lib/apt/lists.broke \ + && mkdir -p /var/lib/apt/lists/partial + +RUN apt-get update + +RUN apt-get install -y \ + node \ + python-pygments \ + && apt-get clean \ + && rm -rf /var/lib/apt/lists/ + +WORKDIR /tmp +ADD Gemfile /tmp/ +ADD Gemfile.lock /tmp/ +RUN bundle install + +VOLUME /src +EXPOSE 4000 + +WORKDIR /src +ENTRYPOINT ["jekyll"] + diff --git a/docs/Gemfile b/docs/Gemfile new file mode 100644 index 000000000..b301edabe --- /dev/null +++ b/docs/Gemfile @@ -0,0 +1,10 @@ +source "https://rubygems.org" + + +gem "jekyll", "3.3.1" + + +group :jekyll_plugins do + gem "jekyll-feed", "~> 0.6" + gem 'github-pages', '~> 106' +end diff --git a/docs/Gemfile.lock b/docs/Gemfile.lock new file mode 100644 index 000000000..dd93f97dd --- /dev/null +++ b/docs/Gemfile.lock @@ -0,0 +1,150 @@ +GEM + remote: https://rubygems.org/ + specs: + activesupport (4.2.7) + i18n (~> 0.7) + json (~> 1.7, >= 1.7.7) + minitest (~> 5.1) + thread_safe (~> 0.3, >= 0.3.4) + tzinfo (~> 1.1) + addressable (2.4.0) + coffee-script (2.4.1) + coffee-script-source + execjs + coffee-script-source (1.11.1) + colorator (1.1.0) + ethon (0.10.1) + ffi (>= 1.3.0) + execjs (2.7.0) + faraday (0.10.0) + multipart-post (>= 1.2, < 3) + ffi (1.9.14) + forwardable-extended (2.6.0) + gemoji (2.1.0) + github-pages (106) + activesupport (= 4.2.7) + github-pages-health-check (= 1.2.0) + jekyll (= 3.3.1) + jekyll-avatar (= 0.4.2) + jekyll-coffeescript (= 1.0.1) + jekyll-feed (= 0.8.0) + jekyll-gist (= 1.4.0) + jekyll-github-metadata (= 2.2.0) + jekyll-mentions (= 1.2.0) + jekyll-paginate (= 1.1.0) + jekyll-redirect-from (= 0.11.0) + jekyll-relative-links (= 0.2.1) + jekyll-sass-converter (= 1.3.0) + jekyll-seo-tag (= 2.1.0) + jekyll-sitemap (= 0.12.0) + jekyll-swiss (= 0.4.0) + jemoji (= 0.7.0) + kramdown (= 1.11.1) + liquid (= 3.0.6) + listen (= 3.0.6) + mercenary (~> 0.3) + minima (= 2.0.0) + rouge (= 1.11.1) + terminal-table (~> 1.4) + github-pages-health-check (1.2.0) + addressable (~> 2.3) + net-dns (~> 0.8) + octokit (~> 4.0) + public_suffix (~> 1.4) + typhoeus (~> 0.7) + html-pipeline (2.4.2) + activesupport (>= 2) + nokogiri (>= 1.4) + i18n (0.7.0) + jekyll (3.3.1) + addressable (~> 2.4) + colorator (~> 1.0) + jekyll-sass-converter (~> 1.0) + jekyll-watch (~> 1.1) + kramdown (~> 1.3) + liquid (~> 3.0) + mercenary (~> 0.3.3) + pathutil (~> 0.9) + rouge (~> 1.7) + safe_yaml (~> 1.0) + jekyll-avatar (0.4.2) + jekyll (~> 3.0) + jekyll-coffeescript (1.0.1) + coffee-script (~> 2.2) + jekyll-feed (0.8.0) + jekyll (~> 3.3) + jekyll-gist (1.4.0) + octokit (~> 4.2) + jekyll-github-metadata (2.2.0) + jekyll (~> 3.1) + octokit (~> 4.0, != 4.4.0) + jekyll-mentions (1.2.0) + activesupport (~> 4.0) + html-pipeline (~> 2.3) + jekyll (~> 3.0) + jekyll-paginate (1.1.0) + jekyll-redirect-from (0.11.0) + jekyll (>= 2.0) + jekyll-relative-links (0.2.1) + jekyll (~> 3.3) + jekyll-sass-converter (1.3.0) + sass (~> 3.2) + jekyll-seo-tag (2.1.0) + jekyll (~> 3.3) + jekyll-sitemap (0.12.0) + jekyll (~> 3.3) + jekyll-swiss (0.4.0) + jekyll-watch (1.5.0) + listen (~> 3.0, < 3.1) + jemoji (0.7.0) + activesupport (~> 4.0) + gemoji (~> 2.0) + html-pipeline (~> 2.2) + jekyll (>= 3.0) + json (1.8.3) + kramdown (1.11.1) + liquid (3.0.6) + listen (3.0.6) + rb-fsevent (>= 0.9.3) + rb-inotify (>= 0.9.7) + mercenary (0.3.6) + mini_portile2 (2.1.0) + minima (2.0.0) + minitest (5.10.1) + multipart-post (2.0.0) + net-dns (0.8.0) + nokogiri (1.6.8.1) + mini_portile2 (~> 2.1.0) + octokit (4.6.2) + sawyer (~> 0.8.0, >= 0.5.3) + pathutil (0.14.0) + forwardable-extended (~> 2.6) + public_suffix (1.5.3) + rb-fsevent (0.9.8) + rb-inotify (0.9.7) + ffi (>= 0.5.0) + rouge (1.11.1) + safe_yaml (1.0.4) + sass (3.4.22) + sawyer (0.8.1) + addressable (>= 2.3.5, < 2.6) + faraday (~> 0.8, < 1.0) + terminal-table (1.7.3) + unicode-display_width (~> 1.1.1) + thread_safe (0.3.5) + typhoeus (0.8.0) + ethon (>= 0.8.0) + tzinfo (1.2.2) + thread_safe (~> 0.1) + unicode-display_width (1.1.1) + +PLATFORMS + ruby + +DEPENDENCIES + github-pages (~> 106) + jekyll (= 3.3.1) + jekyll-feed (~> 0.6) + +BUNDLED WITH + 1.13.7 diff --git a/docs/_config.yml b/docs/_config.yml new file mode 100644 index 000000000..baf6748dc --- /dev/null +++ b/docs/_config.yml @@ -0,0 +1,87 @@ + +output: web +# this property is useful for conditional filtering of content that is separate from the PDF. + +topnav_title: Hoodie +# this appears on the top navigation bar next to the home button + +site_title: Hoodie +# this appears in the html browser tab for the site title (seen mostly by search engines, not users) + +company_name: Uber Technologies Inc. +# this appears in the footer + +github_editme_path: +# if you're using Github, provide the basepath to the branch you've created for reviews, following the sample here. if not, leave this value blank. + +disqus_shortname: +# if you're using disqus for comments, add the shortname here. if not, leave this value blank. + +host: 127.0.0.1 +# the preview server used. Leave as is. + +port: 4000 +# the port where the preview is rendered. You can leave this as is unless you have other Jekyll builds using this same port that might cause conflicts. in that case, use another port such as 4006. + +exclude: + - .idea/ + - .gitignore +# these are the files and directories that jekyll will exclude from the build + +feedback_subject_line: Hoodie Documentation + +feedback_email: hoodie-dev-group@uber.com +# used as a contact email for the Feedback link in the top navigation bar + +# feedback_disable: true +# if you uncomment the previous line, the Feedback link gets removed + +# feedback_text: "Need help?" +# if you uncomment the previous line, it changes the Feedback text + +# feedback_link: "http://helpy.io/" +# if you uncomment the previous line, it changes where the feedback link points to + +highlighter: rouge +# library used for syntax highlighting + +markdown: kramdown +kramdown: + input: GFM + auto_ids: true + hard_wrap: false + syntax_highlighter: rouge + +# filter used to process markdown. note that kramdown differs from github-flavored markdown in some subtle ways + +defaults: + - + scope: + path: "" + type: "pages" + values: + layout: "page" + comments: true + search: true + sidebar: mydoc_sidebar + + - + scope: + path: "" + type: "posts" + values: + layout: "post" + comments: true + search: true + sidebar: mydoc_sidebar + +# these are defaults used for the frontmatter for these file types + +sidebars: +- mydoc_sidebar + +description: "Hoodie is a Spark Library, that provides upserts and incremental processing capaibilities on Hadoop datasets" +# the description is used in the feed.xml file + +# needed for sitemap.xml file only +url: http://github.com/uber/hoodie diff --git a/docs/_data/alerts.yml b/docs/_data/alerts.yml new file mode 100644 index 000000000..157e1622b --- /dev/null +++ b/docs/_data/alerts.yml @@ -0,0 +1,15 @@ +tip: '