Author: liyang
Date: Thu Feb 11 13:08:44 2016
New Revision: 1729820
URL: http://svn.apache.org/viewvc?rev=1729820&view=rev
Log:
minor update on howto_docs
Modified:
kylin/site/development/howto_docs.html
Modified: kylin/site/development/howto_docs.html
URL:
http://svn.apache.org/viewvc/kylin/site/development/howto_docs.html?rev=1729820&r1=1729819&r2=1729820&view=diff
==============================================================================
--- kylin/site/development/howto_docs.html (original)
+++ kylin/site/development/howto_docs.html Thu Feb 11 13:08:44 2016
@@ -439,7 +439,9 @@
<div id="pjax">
<h1
class="post-title">How to Write Document</h1>
<article
class="post-content" >
- <h2
id="before-your-work">Before your work</h2>
+ <p>We write documents
in MD format and convert to HTML using <a
href="http://jekyllrb.com">Jekyll</a>. The Jekyll generated HTML gets uploaded
to apache SVN and becomes Kylin website. All MD source files are managed in git
so all changes and contributors are clearly tracked.</p>
+
+<h2 id="before-your-work">Before your work</h2>
<p>Install following tools before you add or edit documentation:</p>
@@ -475,7 +477,9 @@
<p>To draft Chinese version document or translate existing one, just add or
copy that doc and name with .cn.md as sufffix. It will generate under /cn
folder with same name as html file. <br />
To add other language, please update _config.yml and follow the same pattern
as Chinese version.</p>
-<h1 id="kylin-document-sturcture-and-navigation-menu">Kylin document sturcture
and navigation menu</h1>
+<h1 id="kylin-document-structure-and-navigation-menu">Kylin document structure
and navigation menu</h1>
+
+<p>The Kylin <a
href="https://github.com/apache/kylin/tree/document/website">website as the
Jekyll source</a> is maintained under the <code
class="highlighter-rouge">doucment</code> branch.</p>
<ol>
<li><strong>Home Page</strong>: <em>âindex.mdâ</em> Home page of
Docs</li>