You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@kylin.apache.org by li...@apache.org on 2016/02/01 15:55:42 UTC
svn commit: r1727947 - in /kylin/site: development/howto_contribute.html
development/howto_docs.html development/howto_test.html
docs/howto/howto_use_restapi.html feed.xml
Author: lidong
Date: Mon Feb 1 14:55:41 2016
New Revision: 1727947
URL: http://svn.apache.org/viewvc?rev=1727947&view=rev
Log:
Update documents on env setup
Modified:
kylin/site/development/howto_contribute.html
kylin/site/development/howto_docs.html
kylin/site/development/howto_test.html
kylin/site/docs/howto/howto_use_restapi.html
kylin/site/feed.xml
Modified: kylin/site/development/howto_contribute.html
URL: http://svn.apache.org/viewvc/kylin/site/development/howto_contribute.html?rev=1727947&r1=1727946&r2=1727947&view=diff
==============================================================================
--- kylin/site/development/howto_contribute.html (original)
+++ kylin/site/development/howto_contribute.html Mon Feb 1 14:55:41 2016
@@ -457,7 +457,7 @@
<li>Sufficient unit test and integration test is a mandatory part of code change.</li>
</ul>
</li>
- <li><a href="development/howto_test.html">Run tests</a> to ensure your change is in good quality and does not break anything</li>
+ <li><a href="/development/howto_test.html">Run tests</a> to ensure your change is in good quality and does not break anything</li>
<li>Generate patch and attach it to relative JIRA. Please use <code class="highlighter-rouge">git format-patch</code> command to generate the patch, for a detail guide you can refer to <a href="https://ariejan.net/2009/10/26/how-to-create-and-apply-a-patch-with-git/">How to create and apply a patch with Git</a></li>
</ul>
@@ -465,10 +465,13 @@
<ul>
<li>Committer will review in terms of correctness, performance, design, coding style, test coverage</li>
<li>Discuss and revise if necessary</li>
- <li>Finally committer merge code into target branch</li>
+ <li>Finally committer merge code into target branch
+ <ul>
+ <li>We use <code class="highlighter-rouge">git rebase</code> to ensure the merged result is a streamline of commits.</li>
+ </ul>
+ </li>
</ul>
-
</article>
</div>
</div>
Modified: kylin/site/development/howto_docs.html
URL: http://svn.apache.org/viewvc/kylin/site/development/howto_docs.html?rev=1727947&r1=1727946&r2=1727947&view=diff
==============================================================================
--- kylin/site/development/howto_docs.html (original)
+++ kylin/site/development/howto_docs.html Mon Feb 1 14:55:41 2016
@@ -454,7 +454,11 @@
<li>Then, install <a href="http://jekyllrb.com">Jekyll</a>, and required plugins
<ul>
<li><code class="highlighter-rouge">gem install jekyll jekyll-multiple-languages kramdown rouge</code></li>
- <li><strong>Note</strong>: Some specific version of jekyll and jekyll-multiple-languages does not work together (I got a âundefined methodâ error with jekyll 3.0.1 and jekyll-multiple-languages 2.0.3). In that case, <code class="highlighter-rouge">jekyll 2.5.3</code> and <code class="highlighter-rouge">jekyll-multiple-languages 1.0.8</code> is the known working version.</li>
+ <li><strong>Note</strong>: Some specific version of jekyll and jekyll-multiple-languages does not work together (I got a âundefined methodâ error with jekyll 3.0.1 and jekyll-multiple-languages 2.0.3). In that case, <code class="highlighter-rouge">jekyll 2.5.3</code> and <code class="highlighter-rouge">jekyll-multiple-languages 1.0.8</code> is the known working version.
+ <ul>
+ <li>eg. Use <code class="highlighter-rouge">gem install jekyll --version "=2.5.3"</code> to install a specific version.</li>
+ </ul>
+ </li>
</ul>
</li>
<li>And optionally any markdown editor you prefer</li>
Modified: kylin/site/development/howto_test.html
URL: http://svn.apache.org/viewvc/kylin/site/development/howto_test.html?rev=1727947&r1=1727946&r2=1727947&view=diff
==============================================================================
--- kylin/site/development/howto_test.html (original)
+++ kylin/site/development/howto_test.html Mon Feb 1 14:55:41 2016
@@ -446,12 +446,14 @@
<ul>
<li><code class="highlighter-rouge">mvn test</code> to run unit tests, which has a limited test coverage.
<ul>
+ <li>Unit tests has no external dependency and can run on any machine.</li>
<li>The unit tests do not cover end-to-end scenarios like build, merge, and query.</li>
<li>The unit tests take a few minutes to complete.</li>
</ul>
</li>
<li><code class="highlighter-rouge">dev-support/test_all_against_hdp_2_2_4_2_2.sh</code> to run integration tests, which has the best test coverage.
<ul>
+ <li>Integration tests <strong>must run on a Hadoop sandbox</strong>. Make sure all changes you want to test are avaiable on sandbox.</li>
<li>As the name indicates, the script is only for hdp 2.2.4.2, but you get the idea of how integration test run from it.</li>
<li>The integration tests start from generate random data, then build cube, merge cube, and finally query the result and compare to H2 DB.</li>
<li>The integration tests take a few hours to complete.</li>
Modified: kylin/site/docs/howto/howto_use_restapi.html
URL: http://svn.apache.org/viewvc/kylin/site/docs/howto/howto_use_restapi.html?rev=1727947&r1=1727946&r2=1727947&view=diff
==============================================================================
--- kylin/site/docs/howto/howto_use_restapi.html (original)
+++ kylin/site/docs/howto/howto_use_restapi.html Mon Feb 1 14:55:41 2016
@@ -2484,7 +2484,7 @@ Get descriptor for specified cube instan
<ul>
<li>startTime - <code class="highlighter-rouge">required</code> <code class="highlighter-rouge">long</code> Start timestamp of data to build, e.g. 1388563200000 for 2014-1-1</li>
<li>endTime - <code class="highlighter-rouge">required</code> <code class="highlighter-rouge">long</code> End timestamp of data to build</li>
- <li>buildType - <code class="highlighter-rouge">required</code> <code class="highlighter-rouge">string</code> Build type: âBUILDâ OR âMERGEâ</li>
+ <li>buildType - <code class="highlighter-rouge">required</code> <code class="highlighter-rouge">string</code> Supported build type: âBUILDâ, âMERGEâ, âREFRESHâ</li>
</ul>
<h4 id="response-sample-6">Response Sample</h4>
Modified: kylin/site/feed.xml
URL: http://svn.apache.org/viewvc/kylin/site/feed.xml?rev=1727947&r1=1727946&r2=1727947&view=diff
==============================================================================
--- kylin/site/feed.xml (original)
+++ kylin/site/feed.xml Mon Feb 1 14:55:41 2016
@@ -19,8 +19,8 @@
<description>Apache Kylin Home</description>
<link>http://kylin.apache.org/</link>
<atom:link href="http://kylin.apache.org/feed.xml" rel="self" type="application/rss+xml"/>
- <pubDate>Thu, 21 Jan 2016 00:59:24 -0800</pubDate>
- <lastBuildDate>Thu, 21 Jan 2016 00:59:24 -0800</lastBuildDate>
+ <pubDate>Mon, 01 Feb 2016 06:48:24 -0800</pubDate>
+ <lastBuildDate>Mon, 01 Feb 2016 06:48:24 -0800</lastBuildDate>
<generator>Jekyll v2.5.3</generator>
<item>