You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@zeppelin.apache.org by co...@apache.org on 2016/09/07 12:18:25 UTC
svn commit: r1759602 - /zeppelin/site/contribution/documentation.html
Author: corneadoug
Date: Wed Sep 7 12:18:25 2016
New Revision: 1759602
URL: http://svn.apache.org/viewvc?rev=1759602&view=rev
Log:
Edit documentation contribution page
Modified:
zeppelin/site/contribution/documentation.html
Modified: zeppelin/site/contribution/documentation.html
URL: http://svn.apache.org/viewvc/zeppelin/site/contribution/documentation.html?rev=1759602&r1=1759601&r2=1759602&view=diff
==============================================================================
--- zeppelin/site/contribution/documentation.html (original)
+++ zeppelin/site/contribution/documentation.html Wed Sep 7 12:18:25 2016
@@ -1,5 +1,4 @@
-
<!DOCTYPE html>
<html lang="en">
<head>
@@ -94,9 +93,7 @@
-
- <li><a href="/download.html">Download</a></li>
-
+
@@ -109,9 +106,11 @@
-
-
-
+
+
+ <li><a href="/download.html">Download</a></li>
+
+
@@ -121,14 +120,14 @@
+
+
-
-
@@ -151,13 +150,13 @@
-
-
-
+
+
+
@@ -205,7 +204,6 @@
<div class="content">
-
<div class="row">
<div class="sideMenu col-sm-3">
@@ -252,6 +250,12 @@
+
+ <li><a href="/contribution/webapplication.html">Web Application</a></li>
+
+
+
+
@@ -263,9 +267,7 @@
-
-
-
+
@@ -275,17 +277,13 @@
+
+
-
- <li><a href="/contribution/webapplication.html">Web Application</a></li>
-
-
-
-
@@ -309,13 +307,13 @@
-
-
-
+
+
+
@@ -348,33 +346,32 @@ limitations under the License.
<p>For the more details, see <a href="https://help.github.com/articles/about-github-pages-and-jekyll/">help.github.com/articles/about-github-pages-and-jekyll/</a>.</p>
<h3>Requirements</h3>
-<figure class="highlight"><pre><code class="language-text" data-lang="text"># ruby --version >= 2.0.0
+<div class="highlight"><pre><code class="text language-text" data-lang="text"># ruby --version >= 2.0.0
# Install Bundler using gem
gem install bundler
cd $ZEPPELIN_HOME/docs
# Install all dependencies declared in the Gemfile
bundle install
-</code></pre></figure>
+</code></pre></div>
<p>For the further information about requirements, please see <a href="https://help.github.com/articles/setting-up-your-github-pages-site-locally-with-jekyll/#requirements">here</a>.</p>
<p>On OS X 10.9, you may need to do</p>
-<figure class="highlight"><pre><code class="language-text" data-lang="text">xcode-select --install
-
-</code></pre></figure>
+<div class="highlight"><pre><code class="text language-text" data-lang="text">xcode-select --install
+</code></pre></div>
<h3>Run the website locally</h3>
<p>If you don't want to encounter uglily rendered pages, run the documentation site in your local first.</p>
<p>In <code>$ZEPPELIN_HOME/docs</code> folder, run</p>
-<figure class="highlight"><pre><code class="language-text" data-lang="text">bundle exec jekyll serve --watch
-</code></pre></figure>
+<div class="highlight"><pre><code class="text language-text" data-lang="text">bundle exec jekyll serve --watch
+</code></pre></div>
<p>Using the above command, Jekyll will start a web server at <code>http://localhost:4000</code> and watch the <code>/docs</code> directory to update.</p>
<h2>Folder Structure & Components</h2>
<p><code>docs/</code> folder is organized like below:</p>
-<figure class="highlight"><pre><code class="language-text" data-lang="text">docs/
+<div class="highlight"><pre><code class="text language-text" data-lang="text">docs/
├── _includes/themes/zeppelin
│ ├── _navigation.html
│ └── default.html
@@ -399,7 +396,7 @@ bundle install
├── _config.yml
├── index.md
└── ...
-</code></pre></figure>
+</code></pre></div>
<ul>
<li><code>_navigation.html</code>: the dropdown menu in navbar</li>
<li><code>default.html</code> & <code>_layouts/</code>: define default HTML layout</li>
@@ -422,34 +419,35 @@ bundle install
<p>Every page contains <a href="https://jekyllrb.com/docs/frontmatter/">YAML front matter</a> block in their header. Don't forget to wrap the front matter list with triple-dashed lines(<code>---</code>) like below.
The document page should start this triple-dashed lines. Or you will face 404 error, since Jekyll can't find the page.</p>
-<figure class="highlight"><pre><code class="language-text" data-lang="text">---
+<div class="highlight"><pre><code class="text language-text" data-lang="text">---
layout: page
title: "Apache Zeppelin Tutorial"
description: "This tutorial page contains a short walk-through tutorial that uses Apache Spark backend. Please note that this tutorial is valid for Spark 1.3 and higher."
group: quickstart
---
-</code></pre></figure>
+</code></pre></div>
<ul>
<li><code>layout</code>: the default layout is <code>page</code> which is defined in <code>_layout/page.html</code>.</li>
<li><code>title</code>: the title for the document. Please note that if it needs to include <code>Zeppelin</code>, it should be <code>Apache Zeppelin</code>, not <code>Zeppelin</code>.</li>
<li><code>description</code>: a short description for the document. One or two sentences would be enough. This description also will be shown as an extract sentence when people search pages.</li>
-<li><code>group</code>: a category for the document page, more than on group can be applied by using this syntax:</li>
+<li><p><code>group</code>: a category for the document page, more than on group can be applied by using this syntax:</p>
+<div class="highlight"><pre><code class="text language-text" data-lang="text">group:
+- group1
+- group2
+</code></pre></div></li>
</ul>
-<figure class="highlight"><pre><code class="language-text" data-lang="text"> group:
- - group1
- - group2
-</code></pre></figure>
+
<h3>Headings</h3>
<p>All documents are structured with headings. From these headings, you can automatically generate a <strong>Table of Contents</strong>. There is a simple rule for Zeppelin docs headings.</p>
-<figure class="highlight"><pre><code class="language-text" data-lang="text"># Level-1 heading <- used only for the main title
+<div class="highlight"><pre><code class="text language-text" data-lang="text"># Level-1 heading <- used only for the main title
## Level-2 heading <- start with this
### Level-3 heading
#### Level-4 heading <- won't be converted in TOC from this level
-</code></pre></figure>
+</code></pre></div>
<h3>Table of contents (TOC)</h3>
-<figure class="highlight"><pre><code class="language-text" data-lang="text"><div id="toc"></div>
-</code></pre></figure>
+<div class="highlight"><pre><code class="text language-text" data-lang="text"><div id="toc"></div>
+</code></pre></div>
<p>Add this line below <code># main title</code> in order to generate a <strong>Table of Contents</strong>.</p>
<p>Headings until <code>### (Level-3 heading)</code> are included to TOC.</p>
@@ -475,9 +473,9 @@ group: quickstart
<ol>
<li><p>generate static website in <code>./_site</code></p>
-<figure class="highlight"><pre><code class="language-text" data-lang="text"># go to /docs under Zeppelin source
-bundle exec jekyll build --safe
-</code></pre></figure></li>
+<div class="highlight"><pre><code class="text language-text" data-lang="text"># go to /docs under Zeppelin source
+JEKYLL_ENV=production bundle exec jekyll build
+</code></pre></div></li>
<li><p>checkout ASF repo
<code>
svn co https://svn.apache.org/repos/asf/zeppelin asf-zeppelin
@@ -498,24 +496,6 @@ svn co https://svn.apache.org/repos/asf/
</div>
-
-
-
-
- <script type="text/javascript">
- (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
- (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
- m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
- })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
-
- ga('create', 'UA-45176241-5', 'zeppelin.apache.org');
- ga('require', 'linkid', 'linkid.js');
- ga('send', 'pageview');
-
-</script>
-
-
-
</body>
</html>