Ian Maxon has uploaded a new change for review. https://asterix-gerrit.ics.uci.edu/541
Change subject: Add guide on how to edit site, various tweaks. ...................................................................... Add guide on how to edit site, various tweaks. Change-Id: Iadb5074e130d4a42b2af123fa405e9fc21a14aed --- M _config.yml M _includes/nav_header.html M community.md M content/about.html M content/community.html M content/dev-setup.html M content/download.html M content/index.html M content/pushing.html A content/site.html M content/tools.html A site.md 12 files changed, 449 insertions(+), 177 deletions(-) git pull ssh://asterix-gerrit.ics.uci.edu:29418/incubator-asterixdb-site refs/changes/41/541/1 diff --git a/_config.yml b/_config.yml index e3019e9..babbc7b 100644 --- a/_config.yml +++ b/_config.yml @@ -1,5 +1,4 @@ -url: https://asterixdb.incubator.apache.org/ - +url: "" name: "Apache AsterixDB" STABLE_VERSION: 0.8.7-incubating diff --git a/_includes/nav_header.html b/_includes/nav_header.html index 5123fab..28db61c 100644 --- a/_includes/nav_header.html +++ b/_includes/nav_header.html @@ -38,6 +38,7 @@ <li class="divider"></li> <li class="dropdown-header">For Committers</li> <li><a href="{{ site.url }}pushing.html">Pushing changes</a></li> + <li><a href="{{ site.url }}site.html">Editing this site</a></li> </ul> </li> </ul> diff --git a/community.md b/community.md index 8fcc2c4..40d0231 100644 --- a/community.md +++ b/community.md @@ -52,7 +52,7 @@ |<img src="{{ site.url }}/img/team/steven_jacobs.jpg" width="100" height="100"> | Steven Jacobs | UC Riverside | sjaco002 | |<img src="{{ site.url }}/img/team/ildar_absalyamov.jpg" width="100" height="100"> | Ildar Absalyamov | UC Riverside | ildar | |<img src="{{ site.url }}/img/team/anonymous.jpg" width="100" height="100"> | Preston Carman | UC Riverside | prestonc | -|<img src="{{ site.url }}/img/team/abdullah_alamoudi.jpg" width="100" height="100"> | Abdullah Alamoudi | Saudi Aramco | amoudi | +|<img src="{{ site.url }}/img/team/abdullah_alamoudi.jpg" width="100" height="100"> | Abdullah Alamoudi | Couchbase | amoudi | |<img src="{{ site.url }}/img/team/zachary_heilbron.jpg" width="100" height="100"> | Zach Heilbron | X15 Software | zheilbron | |<img src="{{ site.url }}/img/team/anonymous.jpg" width="100" height="100"> | Markus Dreseler | HPI | mrks | |<img src="{{ site.url }}/img/team/keren_ouaknine.jpg" width="100" height="100"> | Keren Ouaknine | Hebrew University | kereno | diff --git a/content/about.html b/content/about.html index 0f49df3..6333e7d 100644 --- a/content/about.html +++ b/content/about.html @@ -7,16 +7,16 @@ <!-- The above 3 meta tags *must* come first in the head; any other head content must come *after* these tags --> <meta name="description" content=""> <meta name="author" content=""> - <link rel="icon" href="https://asterixdb.incubator.apache.org/favicon.ico";> + <link rel="icon" href="favicon.ico"> <title>About AsterixDB</title> <!-- Bootstrap core CSS --> - <link href="https://asterixdb.incubator.apache.org/css/bootstrap.min.css"; rel="stylesheet"> + <link href="css/bootstrap.min.css" rel="stylesheet"> <!-- Bootstrap theme --> <!-- Custom styles for this template --> - <link href="https://asterixdb.incubator.apache.org/css/theme.css"; rel="stylesheet"> + <link href="css/theme.css" rel="stylesheet"> <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries --> <!--[if lt IE 9]> @@ -29,7 +29,7 @@ <div class="container theme-showcase" role="main"> <div class="masthead"> <p class="lead"> - <a href="https://asterixdb.incubator.apache.org/index.html";><img src="https://asterixdb.incubator.apache.org/img/asterixdb.png"; style="height:75px; width:auto; vertical-align:bottom; margin-top:10px;"/></a> + <a href="index.html"><img src="img/asterixdb.png" style="height:75px; width:auto; vertical-align:bottom; margin-top:10px;"/></a> </p> </div> @@ -42,11 +42,11 @@ <span class="icon-bar"></span> <span class="icon-bar"></span> </button> - <a class="navbar-brand" href="https://asterixdb.incubator.apache.org/index.html";>Overview</a> + <a class="navbar-brand" href="index.html">Overview</a> </div> <div class="navbar-collapse collapse"> <ul class="nav navbar-nav"> - <li><a href="https://asterixdb.incubator.apache.org/download.html";>Download</a></li> + <li><a href="download.html">Download</a></li> <li class="dropdown"> <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">Documentation<span class="caret"></span></a> <ul class="dropdown-menu" role="menu"> @@ -57,16 +57,17 @@ <li><a href="https://ci.apache.org/projects/asterixdb/index.html";>Documentation for 0.8.8-SNAPSHOT <i class="fa fa-external-link fa-sm"></i></a></li> </ul> </li> - <li><a href="https://asterixdb.incubator.apache.org/about.html";>About</a></li> - <li><a href="https://asterixdb.incubator.apache.org/community.html";>Community</a></li> + <li><a href="about.html">About</a></li> + <li><a href="community.html">Community</a></li> <li class="dropdown"> <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">Contributing <span class="caret"></span></a> <ul class="dropdown-menu" role="menu"> <li class="dropdown-header">For New Contributors</li> - <li><a href="https://asterixdb.incubator.apache.org/dev-setup.html";>Development Setup</a></li> + <li><a href="dev-setup.html">Development Setup</a></li> <li class="divider"></li> <li class="dropdown-header">For Committers</li> - <li><a href="https://asterixdb.incubator.apache.org/pushing.html";>Pushing changes</a></li> + <li><a href="pushing.html">Pushing changes</a></li> + <li><a href="site.html">Editing this site</a></li> </ul> </li> </ul> @@ -118,7 +119,7 @@ <p>Apache AsterixDB, Apache, and the Apache feather logo are trademarks of the Apache Software Foundation</p> </div> <div class="col-md-1 text-right"> - <img src="https://asterixdb.incubator.apache.org/img/egg-logo.png"; style="height:auto; width:200px; vertical-align:bottom;"/> + <img src="img/egg-logo.png" style="height:auto; width:200px; vertical-align:bottom;"/> </div> </div> </footer> @@ -129,6 +130,6 @@ ================================================== --> <!-- Placed at the end of the document so the pages load faster --> <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.2/jquery.min.js";></script> - <script src="https://asterixdb.incubator.apache.org/js/bootstrap.min.js";></script> + <script src="js/bootstrap.min.js"></script> </body> </html> diff --git a/content/community.html b/content/community.html index 9ab8a30..18827cf 100644 --- a/content/community.html +++ b/content/community.html @@ -7,16 +7,16 @@ <!-- The above 3 meta tags *must* come first in the head; any other head content must come *after* these tags --> <meta name="description" content=""> <meta name="author" content=""> - <link rel="icon" href="https://asterixdb.incubator.apache.org/favicon.ico";> + <link rel="icon" href="favicon.ico"> <title>Community</title> <!-- Bootstrap core CSS --> - <link href="https://asterixdb.incubator.apache.org/css/bootstrap.min.css"; rel="stylesheet"> + <link href="css/bootstrap.min.css" rel="stylesheet"> <!-- Bootstrap theme --> <!-- Custom styles for this template --> - <link href="https://asterixdb.incubator.apache.org/css/theme.css"; rel="stylesheet"> + <link href="css/theme.css" rel="stylesheet"> <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries --> <!--[if lt IE 9]> @@ -29,7 +29,7 @@ <div class="container theme-showcase" role="main"> <div class="masthead"> <p class="lead"> - <a href="https://asterixdb.incubator.apache.org/index.html";><img src="https://asterixdb.incubator.apache.org/img/asterixdb.png"; style="height:75px; width:auto; vertical-align:bottom; margin-top:10px;"/></a> + <a href="index.html"><img src="img/asterixdb.png" style="height:75px; width:auto; vertical-align:bottom; margin-top:10px;"/></a> </p> </div> @@ -42,11 +42,11 @@ <span class="icon-bar"></span> <span class="icon-bar"></span> </button> - <a class="navbar-brand" href="https://asterixdb.incubator.apache.org/index.html";>Overview</a> + <a class="navbar-brand" href="index.html">Overview</a> </div> <div class="navbar-collapse collapse"> <ul class="nav navbar-nav"> - <li><a href="https://asterixdb.incubator.apache.org/download.html";>Download</a></li> + <li><a href="download.html">Download</a></li> <li class="dropdown"> <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">Documentation<span class="caret"></span></a> <ul class="dropdown-menu" role="menu"> @@ -57,16 +57,17 @@ <li><a href="https://ci.apache.org/projects/asterixdb/index.html";>Documentation for 0.8.8-SNAPSHOT <i class="fa fa-external-link fa-sm"></i></a></li> </ul> </li> - <li><a href="https://asterixdb.incubator.apache.org/about.html";>About</a></li> - <li><a href="https://asterixdb.incubator.apache.org/community.html";>Community</a></li> + <li><a href="about.html">About</a></li> + <li><a href="community.html">Community</a></li> <li class="dropdown"> <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">Contributing <span class="caret"></span></a> <ul class="dropdown-menu" role="menu"> <li class="dropdown-header">For New Contributors</li> - <li><a href="https://asterixdb.incubator.apache.org/dev-setup.html";>Development Setup</a></li> + <li><a href="dev-setup.html">Development Setup</a></li> <li class="divider"></li> <li class="dropdown-header">For Committers</li> - <li><a href="https://asterixdb.incubator.apache.org/pushing.html";>Pushing changes</a></li> + <li><a href="pushing.html">Pushing changes</a></li> + <li><a href="site.html">Editing this site</a></li> </ul> </li> </ul> @@ -147,145 +148,145 @@ </thead> <tbody> <tr> - <td><img src="https://asterixdb.incubator.apache.org//img/team/michael_carey.jpg"; width="100" height="100" /></td> + <td><img src="/img/team/michael_carey.jpg" width="100" height="100" /></td> <td>Michael Carey</td> <td>UC Irvine</td> <td>dtabass</td> </tr> <tr> - <td><img src="https://asterixdb.incubator.apache.org//img/team/till_westmann.jpg"; width="100" height="100" /></td> + <td><img src="/img/team/till_westmann.jpg" width="100" height="100" /></td> <td>Till Westmann</td> <td>Couchbase</td> <td>tillw</td> </tr> <tr> - <td><img src="https://asterixdb.incubator.apache.org//img/team/vinayak_borkar.jpg"; width="100" height="100" /></td> + <td><img src="/img/team/vinayak_borkar.jpg" width="100" height="100" /></td> <td>Vinayak Borkar</td> <td>X15 Software</td> <td>vborkar</td> </tr> <tr> - <td><img src="https://asterixdb.incubator.apache.org//img/team/vassilis_tsotras.jpg"; width="100" height="100" /></td> + <td><img src="/img/team/vassilis_tsotras.jpg" width="100" height="100" /></td> <td>Vassilis Tsotras</td> <td>UC Riverside</td> <td>tsotras</td> </tr> <tr> - <td><img src="https://asterixdb.incubator.apache.org//img/team/chen_li.jpg"; width="100" height="100" /></td> + <td><img src="/img/team/chen_li.jpg" width="100" height="100" /></td> <td>Chen Li</td> <td>UC Irvine</td> <td>chenli</td> </tr> <tr> - <td><img src="https://asterixdb.incubator.apache.org//img/team/yingyi_bu.jpg"; width="100" height="100" /></td> + <td><img src="/img/team/yingyi_bu.jpg" width="100" height="100" /></td> <td>Yingyi Bu</td> <td>UC Irvine</td> <td>yingyib</td> </tr> <tr> - <td><img src="https://asterixdb.incubator.apache.org//img/team/young_seok_kim.jpg"; width="100" height="100" /></td> + <td><img src="/img/team/young_seok_kim.jpg" width="100" height="100" /></td> <td>Young-Seok Kim</td> <td>UC Irvine</td> <td>kisskys</td> </tr> <tr> - <td><img src="https://asterixdb.incubator.apache.org//img/team/inci_cetindil.jpg"; width="100" height="100" /></td> + <td><img src="/img/team/inci_cetindil.jpg" width="100" height="100" /></td> <td>Inci Cetindil</td> <td>UC Irvine</td> <td>icetindil</td> </tr> <tr> - <td><img src="https://asterixdb.incubator.apache.org//img/team/raman_grover.jpg"; width="100" height="100" /></td> + <td><img src="/img/team/raman_grover.jpg" width="100" height="100" /></td> <td>Raman Grover</td> <td>Microsoft Research</td> <td>raman</td> </tr> <tr> - <td><img src="https://asterixdb.incubator.apache.org//img/team/pouria_pirzadeh.jpg"; width="100" height="100" /></td> + <td><img src="/img/team/pouria_pirzadeh.jpg" width="100" height="100" /></td> <td>Pouria Pirzadeh</td> <td>UC Irvine</td> <td>pouria</td> </tr> <tr> - <td><img src="https://asterixdb.incubator.apache.org//img/team/murtadha_hubail.jpg"; width="100" height="100" /></td> + <td><img src="/img/team/murtadha_hubail.jpg" width="100" height="100" /></td> <td>Murtadha Hubail</td> <td>UC Irvine</td> <td>mhubail</td> </tr> <tr> - <td><img src="https://asterixdb.incubator.apache.org//img/team/ian_maxon.jpg"; width="100" height="100" /></td> + <td><img src="/img/team/ian_maxon.jpg" width="100" height="100" /></td> <td>Ian Maxon</td> <td>UC Irvine</td> <td>imaxon</td> </tr> <tr> - <td><img src="https://asterixdb.incubator.apache.org//img/team/jianfeng_jia.jpg"; width="100" height="100" /></td> + <td><img src="/img/team/jianfeng_jia.jpg" width="100" height="100" /></td> <td>Jianfeng Jia</td> <td>UC Irvine</td> <td>jianfeng</td> </tr> <tr> - <td><img src="https://asterixdb.incubator.apache.org//img/team/taewoo_kim.jpg"; width="100" height="100" /></td> + <td><img src="/img/team/taewoo_kim.jpg" width="100" height="100" /></td> <td>Taewoo Kim</td> <td>UC Irvine</td> <td>wangsaeu</td> </tr> <tr> - <td><img src="https://asterixdb.incubator.apache.org//img/team/anonymous.jpg"; width="100" height="100" /></td> + <td><img src="/img/team/anonymous.jpg" width="100" height="100" /></td> <td>Cameron Samak</td> <td>UC Irvine</td> <td>csamak</td> </tr> <tr> - <td><img src="https://asterixdb.incubator.apache.org//img/team/sattam_alsubaiee.png"; width="100" height="100" /></td> + <td><img src="/img/team/sattam_alsubaiee.png" width="100" height="100" /></td> <td>Sattam Alsubaiee</td> <td>KACST Saudi Arabia</td> <td>salsubaiee</td> </tr> <tr> - <td><img src="https://asterixdb.incubator.apache.org//img/team/steven_jacobs.jpg"; width="100" height="100" /></td> + <td><img src="/img/team/steven_jacobs.jpg" width="100" height="100" /></td> <td>Steven Jacobs</td> <td>UC Riverside</td> <td>sjaco002</td> </tr> <tr> - <td><img src="https://asterixdb.incubator.apache.org//img/team/ildar_absalyamov.jpg"; width="100" height="100" /></td> + <td><img src="/img/team/ildar_absalyamov.jpg" width="100" height="100" /></td> <td>Ildar Absalyamov</td> <td>UC Riverside</td> <td>ildar</td> </tr> <tr> - <td><img src="https://asterixdb.incubator.apache.org//img/team/anonymous.jpg"; width="100" height="100" /></td> + <td><img src="/img/team/anonymous.jpg" width="100" height="100" /></td> <td>Preston Carman</td> <td>UC Riverside</td> <td>prestonc</td> </tr> <tr> - <td><img src="https://asterixdb.incubator.apache.org//img/team/abdullah_alamoudi.jpg"; width="100" height="100" /></td> + <td><img src="/img/team/abdullah_alamoudi.jpg" width="100" height="100" /></td> <td>Abdullah Alamoudi</td> - <td>Saudi Aramco</td> + <td>Couchbase</td> <td>amoudi</td> </tr> <tr> - <td><img src="https://asterixdb.incubator.apache.org//img/team/zachary_heilbron.jpg"; width="100" height="100" /></td> + <td><img src="/img/team/zachary_heilbron.jpg" width="100" height="100" /></td> <td>Zach Heilbron</td> <td>X15 Software</td> <td>zheilbron</td> </tr> <tr> - <td><img src="https://asterixdb.incubator.apache.org//img/team/anonymous.jpg"; width="100" height="100" /></td> + <td><img src="/img/team/anonymous.jpg" width="100" height="100" /></td> <td>Markus Dreseler</td> <td>HPI</td> <td>mrks</td> </tr> <tr> - <td><img src="https://asterixdb.incubator.apache.org//img/team/keren_ouaknine.jpg"; width="100" height="100" /></td> + <td><img src="/img/team/keren_ouaknine.jpg" width="100" height="100" /></td> <td>Keren Ouaknine</td> <td>Hebrew University</td> <td>kereno</td> </tr> <tr> - <td><img src="https://asterixdb.incubator.apache.org//img/team/chris_hillery.jpg"; width="100" height="100" /></td> + <td><img src="/img/team/chris_hillery.jpg" width="100" height="100" /></td> <td>Chris Hillery</td> <td>Couchbase</td> <td>ceej</td> @@ -307,12 +308,12 @@ </thead> <tbody> <tr> - <td><img src="https://asterixdb.incubator.apache.org//img/team/eugenia_gabrielova.jpg"; width="100" height="100" /></td> + <td><img src="/img/team/eugenia_gabrielova.jpg" width="100" height="100" /></td> <td>Eugenia Gabrielova</td> <td>UC Irvine</td> </tr> <tr> - <td><img src="https://asterixdb.incubator.apache.org//img/team/heri_ramampiaro.jpg"; width="100" height="100" /></td> + <td><img src="/img/team/heri_ramampiaro.jpg" width="100" height="100" /></td> <td>Heri Ramampiaro</td> <td>NTNU Trondheim</td> </tr> @@ -332,7 +333,7 @@ <p>Apache AsterixDB, Apache, and the Apache feather logo are trademarks of the Apache Software Foundation</p> </div> <div class="col-md-1 text-right"> - <img src="https://asterixdb.incubator.apache.org/img/egg-logo.png"; style="height:auto; width:200px; vertical-align:bottom;"/> + <img src="img/egg-logo.png" style="height:auto; width:200px; vertical-align:bottom;"/> </div> </div> </footer> @@ -343,6 +344,6 @@ ================================================== --> <!-- Placed at the end of the document so the pages load faster --> <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.2/jquery.min.js";></script> - <script src="https://asterixdb.incubator.apache.org/js/bootstrap.min.js";></script> + <script src="js/bootstrap.min.js"></script> </body> </html> diff --git a/content/dev-setup.html b/content/dev-setup.html index 00a4e16..f3557d6 100644 --- a/content/dev-setup.html +++ b/content/dev-setup.html @@ -7,16 +7,16 @@ <!-- The above 3 meta tags *must* come first in the head; any other head content must come *after* these tags --> <meta name="description" content=""> <meta name="author" content=""> - <link rel="icon" href="https://asterixdb.incubator.apache.org/favicon.ico";> + <link rel="icon" href="favicon.ico"> <title>Contributing to AsterixDB</title> <!-- Bootstrap core CSS --> - <link href="https://asterixdb.incubator.apache.org/css/bootstrap.min.css"; rel="stylesheet"> + <link href="css/bootstrap.min.css" rel="stylesheet"> <!-- Bootstrap theme --> <!-- Custom styles for this template --> - <link href="https://asterixdb.incubator.apache.org/css/theme.css"; rel="stylesheet"> + <link href="css/theme.css" rel="stylesheet"> <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries --> <!--[if lt IE 9]> @@ -29,7 +29,7 @@ <div class="container theme-showcase" role="main"> <div class="masthead"> <p class="lead"> - <a href="https://asterixdb.incubator.apache.org/index.html";><img src="https://asterixdb.incubator.apache.org/img/asterixdb.png"; style="height:75px; width:auto; vertical-align:bottom; margin-top:10px;"/></a> + <a href="index.html"><img src="img/asterixdb.png" style="height:75px; width:auto; vertical-align:bottom; margin-top:10px;"/></a> </p> </div> @@ -42,11 +42,11 @@ <span class="icon-bar"></span> <span class="icon-bar"></span> </button> - <a class="navbar-brand" href="https://asterixdb.incubator.apache.org/index.html";>Overview</a> + <a class="navbar-brand" href="index.html">Overview</a> </div> <div class="navbar-collapse collapse"> <ul class="nav navbar-nav"> - <li><a href="https://asterixdb.incubator.apache.org/download.html";>Download</a></li> + <li><a href="download.html">Download</a></li> <li class="dropdown"> <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">Documentation<span class="caret"></span></a> <ul class="dropdown-menu" role="menu"> @@ -57,16 +57,17 @@ <li><a href="https://ci.apache.org/projects/asterixdb/index.html";>Documentation for 0.8.8-SNAPSHOT <i class="fa fa-external-link fa-sm"></i></a></li> </ul> </li> - <li><a href="https://asterixdb.incubator.apache.org/about.html";>About</a></li> - <li><a href="https://asterixdb.incubator.apache.org/community.html";>Community</a></li> + <li><a href="about.html">About</a></li> + <li><a href="community.html">Community</a></li> <li class="dropdown"> <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">Contributing <span class="caret"></span></a> <ul class="dropdown-menu" role="menu"> <li class="dropdown-header">For New Contributors</li> - <li><a href="https://asterixdb.incubator.apache.org/dev-setup.html";>Development Setup</a></li> + <li><a href="dev-setup.html">Development Setup</a></li> <li class="divider"></li> <li class="dropdown-header">For Committers</li> - <li><a href="https://asterixdb.incubator.apache.org/pushing.html";>Pushing changes</a></li> + <li><a href="pushing.html">Pushing changes</a></li> + <li><a href="site.html">Editing this site</a></li> </ul> </li> </ul> @@ -139,31 +140,34 @@ <h3 id="steps">Steps</h3> <ol> - <li> - <p>Check out Hyracks and Asterix master in two folders via git in the command line. Assume that the path is <code>$HOME/workspace</code>.</p> + <li>Check out Hyracks and Asterix master in two folders via git in the command line. Assume that the path is <code>$HOME/workspace</code>.</li> +</ol> - <pre><code> git clone https://github.com/apache/incubator-asterixdb/ - git clone https://github.com/apache/incubator-asterixdb-hyracks/ +<pre><code> git clone https://github.com/apache/incubator-asterixdb/ + git clone https://github.com/apache/incubator-asterixdb-hyracks/ + +You will now have `$HOME/workspace/incubator-asterixdb/` and `$HOME/workspace/incubator-asterixdb-hyracks/`. </code></pre> - <p>You will now have <code>$HOME/workspace/incubator-asterixdb/</code> and <code>$HOME/workspace/incubator-asterixdb-hyracks/</code>.</p> - </li> - <li> - <p>Go to the hyracks and install it’s artifacts to the local Maven repository by executing the following commands:</p> +<ol> + <li>Go to the hyracks and install it’s artifacts to the local Maven repository by executing the following commands:</li> +</ol> - <pre><code> cd incubator-asterixdb-hyracks/ - mvn install -DskipTests +<pre><code> cd incubator-asterixdb-hyracks/ + mvn install -DskipTests </code></pre> - </li> - <li> - <p>Go to the asterixdb folder and perform the same action:</p> - <pre><code> cd ../incubator-asterixdb/asterix-maven-plugins/ - mvn install -DskipTests - cd ../ - mvn install -DskipTests +<ol> + <li>Go to the asterixdb folder and perform the same action:</li> +</ol> + +<pre><code> cd ../incubator-asterixdb/asterix-maven-plugins/ + mvn install -DskipTests + cd ../ + mvn install -DskipTests </code></pre> - </li> + +<ol> <li>In Eclipse, import hyracks as an existing Maven Project. <ul> <li><code>File -> Import -> Maven -> Existing Maven Projects -> Next</code></li> @@ -272,62 +276,68 @@ <h3 id="once-per-repository-tasks">Once-per-repository tasks</h3> <ol> - <li> - <p>To work on (say) Asterix, first clone the Google Code repository (if you already have a local clone, great!).</p> - - <p>git clone https://github.com/apache/incubator-asterixdb</p> - </li> - <li> - <p><code>cd</code> into the clone repo directory, and then run the following command to create the “gerrit” remote.</p> - - <p>git gerrit init</p> - </li> + <li>To work on (say) Asterix, first clone the Google Code repository (if you already have a local clone, great!).</li> </ol> + +<pre><code> git clone https://github.com/apache/incubator-asterixdb +</code></pre> + +<ol> + <li><code>cd</code> into the clone repo directory, and then run the following command to create the “gerrit” remote.</li> +</ol> + +<pre><code> git gerrit init +</code></pre> <hr /> <h2 id="making-changes---working-method">Making Changes - working method</h2> <ol> - <li> - <p>When you want to start working on a bug, feature, etc, first make a local <code>git</code> branch. Never work directly on <code>master</code>! <code>master</code> should always be a pure mirror of <code>origin/master</code>, ie, Google Code.</p> + <li>When you want to start working on a bug, feature, etc, first make a local <code>git</code> branch. Never work directly on <code>master</code>! <code>master</code> should always be a pure mirror of <code>origin/master</code>, ie, Google Code.</li> +</ol> - <pre><code> git checkout -b my_branch +<pre><code> git checkout -b my_branch </code></pre> - </li> + +<ol> <li>Make your changes, test them, etc. Feel free to <code>git commit</code> as often as you like.</li> - <li> - <p><strong>Optional</strong>: If you like, you can push your branch up to Google Code, either to share it with others or as a backup. You may do this at whatever point in time you like.</p> + <li><strong>Optional</strong>: If you like, you can push your branch up to Google Code, either to share it with others or as a backup. You may do this at whatever point in time you like.</li> +</ol> - <pre><code> git push origin my_branch +<pre><code> git push origin my_branch </code></pre> - </li> - <li> - <p>Every so often, you should update your local <code>master</code> mirror, and then merge that onto your working branch. This will prevent your branch from falling too far out of date, and ensure that your code review proposals will merge successfully with <code>master</code>. There are a number of ways to do this, but <code>git-gerrit</code> provides a convenience function:</p> - <pre><code> git gerrit update -</code></pre> - </li> - <li> - <p>When you are ready to submit changes for code review, first ensure that you have committed everything locally that is necessary (<code>git status</code> should report “nothing to commit, working directory clean”). This is also a good time to update (see step 4). Then run:</p> +<ol> + <li>Every so often, you should update your local <code>master</code> mirror, and then merge that onto your working branch. This will prevent your branch from falling too far out of date, and ensure that your code review proposals will merge successfully with <code>master</code>. There are a number of ways to do this, but <code>git-gerrit</code> provides a convenience function:</li> +</ol> - <pre><code> git gerrit submit +<pre><code> git gerrit update </code></pre> - </li> + +<ol> + <li>When you are ready to submit changes for code review, first ensure that you have committed everything locally that is necessary (<code>git status</code> should report “nothing to commit, working directory clean”). This is also a good time to update (see step 4). Then run:</li> +</ol> + +<pre><code> git gerrit submit +</code></pre> + +<ol> <li>This will pop open your editor to invite you to create a good commit message. This will be the single commit message which will be the only one to appear in the project’s master git history. Take the time to make it clear. The editor will contain the log messages of everything you committed on your branch as a reminder, but generally you will want to delete all this and replace it with a comprehensive message. Also: As noted in the initial message, the last line of the buffer will contain a <code>Change-Id</code> field. Do not delete that line! It is used by Gerrit to identify this particular merge proposal.</li> - <li> - <p>When you save your commit message, git-gerrit will push all of the changes from your working branch up to Gerrit. Assuming no errors, you should see output similar to the following:</p> + <li>When you save your commit message, git-gerrit will push all of the changes from your working branch up to Gerrit. Assuming no errors, you should see output similar to the following:</li> +</ol> - <pre><code> remote: Resolving deltas: 100% (1/1) - remote: Processing changes: new: 1, refs: 1, done - remote: - remote: New Changes: - remote: http://fulliautomatix.ics.uci.edu:8443/30 - remote: - To ssh://[email protected]:29418/ceej-gerrit-test - * [new branch] HEAD -> refs/for/master +<pre><code> remote: Resolving deltas: 100% (1/1) + remote: Processing changes: new: 1, refs: 1, done + remote: + remote: New Changes: + remote: http://fulliautomatix.ics.uci.edu:8443/30 + remote: + To ssh://[email protected]:29418/ceej-gerrit-test + * [new branch] HEAD -> refs/for/master </code></pre> - </li> + +<ol> <li>That URL under “New Changes” is your code review! Send it to others to request reviews.</li> <li>If you get any negative code reviews and need to make changes, you can just repeat steps 2 - 6 of the working method. Your local branch will still have all the history you put there, if you need to revert changes or look back and see what you did, etc.</li> <li>When you repeat step 6, you will notice two things: First, git-gerrit keeps the change message for you, including the Change-Id, so you don’t have to re-invent it every time. Second, the output from <code>git gerrit submit</code> will not include the URL of the review this time. I’m not sure why; I wish it did. But if you re-visit the old URL in your browser, you should see an additional “Patch Set” containing your revised changes for people to review.</li> @@ -392,7 +402,7 @@ <p>Apache AsterixDB, Apache, and the Apache feather logo are trademarks of the Apache Software Foundation</p> </div> <div class="col-md-1 text-right"> - <img src="https://asterixdb.incubator.apache.org/img/egg-logo.png"; style="height:auto; width:200px; vertical-align:bottom;"/> + <img src="img/egg-logo.png" style="height:auto; width:200px; vertical-align:bottom;"/> </div> </div> </footer> @@ -403,6 +413,6 @@ ================================================== --> <!-- Placed at the end of the document so the pages load faster --> <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.2/jquery.min.js";></script> - <script src="https://asterixdb.incubator.apache.org/js/bootstrap.min.js";></script> + <script src="js/bootstrap.min.js"></script> </body> </html> diff --git a/content/download.html b/content/download.html index af7c387..7184262 100644 --- a/content/download.html +++ b/content/download.html @@ -7,16 +7,16 @@ <!-- The above 3 meta tags *must* come first in the head; any other head content must come *after* these tags --> <meta name="description" content=""> <meta name="author" content=""> - <link rel="icon" href="https://asterixdb.incubator.apache.org/favicon.ico";> + <link rel="icon" href="favicon.ico"> <title>Download</title> <!-- Bootstrap core CSS --> - <link href="https://asterixdb.incubator.apache.org/css/bootstrap.min.css"; rel="stylesheet"> + <link href="css/bootstrap.min.css" rel="stylesheet"> <!-- Bootstrap theme --> <!-- Custom styles for this template --> - <link href="https://asterixdb.incubator.apache.org/css/theme.css"; rel="stylesheet"> + <link href="css/theme.css" rel="stylesheet"> <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries --> <!--[if lt IE 9]> @@ -29,7 +29,7 @@ <div class="container theme-showcase" role="main"> <div class="masthead"> <p class="lead"> - <a href="https://asterixdb.incubator.apache.org/index.html";><img src="https://asterixdb.incubator.apache.org/img/asterixdb.png"; style="height:75px; width:auto; vertical-align:bottom; margin-top:10px;"/></a> + <a href="index.html"><img src="img/asterixdb.png" style="height:75px; width:auto; vertical-align:bottom; margin-top:10px;"/></a> </p> </div> @@ -42,11 +42,11 @@ <span class="icon-bar"></span> <span class="icon-bar"></span> </button> - <a class="navbar-brand" href="https://asterixdb.incubator.apache.org/index.html";>Overview</a> + <a class="navbar-brand" href="index.html">Overview</a> </div> <div class="navbar-collapse collapse"> <ul class="nav navbar-nav"> - <li><a href="https://asterixdb.incubator.apache.org/download.html";>Download</a></li> + <li><a href="download.html">Download</a></li> <li class="dropdown"> <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">Documentation<span class="caret"></span></a> <ul class="dropdown-menu" role="menu"> @@ -57,16 +57,17 @@ <li><a href="https://ci.apache.org/projects/asterixdb/index.html";>Documentation for 0.8.8-SNAPSHOT <i class="fa fa-external-link fa-sm"></i></a></li> </ul> </li> - <li><a href="https://asterixdb.incubator.apache.org/about.html";>About</a></li> - <li><a href="https://asterixdb.incubator.apache.org/community.html";>Community</a></li> + <li><a href="about.html">About</a></li> + <li><a href="community.html">Community</a></li> <li class="dropdown"> <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">Contributing <span class="caret"></span></a> <ul class="dropdown-menu" role="menu"> <li class="dropdown-header">For New Contributors</li> - <li><a href="https://asterixdb.incubator.apache.org/dev-setup.html";>Development Setup</a></li> + <li><a href="dev-setup.html">Development Setup</a></li> <li class="divider"></li> <li class="dropdown-header">For Committers</li> - <li><a href="https://asterixdb.incubator.apache.org/pushing.html";>Pushing changes</a></li> + <li><a href="pushing.html">Pushing changes</a></li> + <li><a href="site.html">Editing this site</a></li> </ul> </li> </ul> @@ -193,7 +194,7 @@ <p>Apache AsterixDB, Apache, and the Apache feather logo are trademarks of the Apache Software Foundation</p> </div> <div class="col-md-1 text-right"> - <img src="https://asterixdb.incubator.apache.org/img/egg-logo.png"; style="height:auto; width:200px; vertical-align:bottom;"/> + <img src="img/egg-logo.png" style="height:auto; width:200px; vertical-align:bottom;"/> </div> </div> </footer> @@ -204,6 +205,6 @@ ================================================== --> <!-- Placed at the end of the document so the pages load faster --> <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.2/jquery.min.js";></script> - <script src="https://asterixdb.incubator.apache.org/js/bootstrap.min.js";></script> + <script src="js/bootstrap.min.js"></script> </body> </html> diff --git a/content/index.html b/content/index.html index afc8f89..7fae90c 100644 --- a/content/index.html +++ b/content/index.html @@ -7,16 +7,16 @@ <!-- The above 3 meta tags *must* come first in the head; any other head content must come *after* these tags --> <meta name="description" content=""> <meta name="author" content=""> - <link rel="icon" href="https://asterixdb.incubator.apache.org/favicon.ico";> + <link rel="icon" href="favicon.ico"> <title>Apache AsterixDB</title> <!-- Bootstrap core CSS --> - <link href="https://asterixdb.incubator.apache.org/css/bootstrap.min.css"; rel="stylesheet"> + <link href="css/bootstrap.min.css" rel="stylesheet"> <!-- Bootstrap theme --> <!-- Custom styles for this template --> - <link href="https://asterixdb.incubator.apache.org/css/theme.css"; rel="stylesheet"> + <link href="css/theme.css" rel="stylesheet"> <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries --> <!--[if lt IE 9]> @@ -29,7 +29,7 @@ <div class="container theme-showcase" role="main"> <div class="masthead"> <p class="lead"> - <a href="https://asterixdb.incubator.apache.org/index.html";><img src="https://asterixdb.incubator.apache.org/img/asterixdb.png"; style="height:75px; width:auto; vertical-align:bottom; margin-top:10px;"/></a> + <a href="index.html"><img src="img/asterixdb.png" style="height:75px; width:auto; vertical-align:bottom; margin-top:10px;"/></a> </p> </div> @@ -42,11 +42,11 @@ <span class="icon-bar"></span> <span class="icon-bar"></span> </button> - <a class="navbar-brand" href="https://asterixdb.incubator.apache.org/index.html";>Overview</a> + <a class="navbar-brand" href="index.html">Overview</a> </div> <div class="navbar-collapse collapse"> <ul class="nav navbar-nav"> - <li><a href="https://asterixdb.incubator.apache.org/download.html";>Download</a></li> + <li><a href="download.html">Download</a></li> <li class="dropdown"> <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">Documentation<span class="caret"></span></a> <ul class="dropdown-menu" role="menu"> @@ -57,16 +57,17 @@ <li><a href="https://ci.apache.org/projects/asterixdb/index.html";>Documentation for 0.8.8-SNAPSHOT <i class="fa fa-external-link fa-sm"></i></a></li> </ul> </li> - <li><a href="https://asterixdb.incubator.apache.org/about.html";>About</a></li> - <li><a href="https://asterixdb.incubator.apache.org/community.html";>Community</a></li> + <li><a href="about.html">About</a></li> + <li><a href="community.html">Community</a></li> <li class="dropdown"> <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">Contributing <span class="caret"></span></a> <ul class="dropdown-menu" role="menu"> <li class="dropdown-header">For New Contributors</li> - <li><a href="https://asterixdb.incubator.apache.org/dev-setup.html";>Development Setup</a></li> + <li><a href="dev-setup.html">Development Setup</a></li> <li class="divider"></li> <li class="dropdown-header">For Committers</li> - <li><a href="https://asterixdb.incubator.apache.org/pushing.html";>Pushing changes</a></li> + <li><a href="pushing.html">Pushing changes</a></li> + <li><a href="site.html">Editing this site</a></li> </ul> </li> </ul> @@ -231,9 +232,9 @@ </div> <div class="col-md-6"> <h3 id="community-and-support">Community and Support</h3> - <p>If you have any questions, please feel free to ask on our <a href="mailto:users@asterixdb.incubator.apache.org">users</a> mailing list, which you can subscribe to by sending an empty email to <a href="[email protected]">users-subscribe</a>. Check out the <a href="https://asterixdb.incubator.apache.org/community.html";>Community</a> page for more details.</p> + <p>If you have any questions, please feel free to ask on our <a href="mailto:users@asterixdb.incubator.apache.org">users</a> mailing list, which you can subscribe to by sending an empty email to <a href="[email protected]">users-subscribe</a>. Check out the <a href="community.html">Community</a> page for more details.</p> - <p>If you would like to know more about how to contribute to AsterixDB or any of its related components, head on over to the <a href="https://asterixdb.incubator.apache.org/dev-setup.html";>Contributing</a> page to learn more.</p> + <p>If you would like to know more about how to contribute to AsterixDB or any of its related components, head on over to the <a href="dev-setup.html">Contributing</a> page to learn more.</p> </div> </div> @@ -247,7 +248,7 @@ <p>Apache AsterixDB, Apache, and the Apache feather logo are trademarks of the Apache Software Foundation</p> </div> <div class="col-md-1 text-right"> - <img src="https://asterixdb.incubator.apache.org/img/egg-logo.png"; style="height:auto; width:200px; vertical-align:bottom;"/> + <img src="img/egg-logo.png" style="height:auto; width:200px; vertical-align:bottom;"/> </div> </div> </footer> @@ -258,6 +259,6 @@ ================================================== --> <!-- Placed at the end of the document so the pages load faster --> <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.2/jquery.min.js";></script> - <script src="https://asterixdb.incubator.apache.org/js/bootstrap.min.js";></script> + <script src="js/bootstrap.min.js"></script> </body> </html> diff --git a/content/pushing.html b/content/pushing.html index e9eeaaf..320e64b 100644 --- a/content/pushing.html +++ b/content/pushing.html @@ -7,16 +7,16 @@ <!-- The above 3 meta tags *must* come first in the head; any other head content must come *after* these tags --> <meta name="description" content=""> <meta name="author" content=""> - <link rel="icon" href="https://asterixdb.incubator.apache.org/favicon.ico";> + <link rel="icon" href="favicon.ico"> <title>Submitting Changes</title> <!-- Bootstrap core CSS --> - <link href="https://asterixdb.incubator.apache.org/css/bootstrap.min.css"; rel="stylesheet"> + <link href="css/bootstrap.min.css" rel="stylesheet"> <!-- Bootstrap theme --> <!-- Custom styles for this template --> - <link href="https://asterixdb.incubator.apache.org/css/theme.css"; rel="stylesheet"> + <link href="css/theme.css" rel="stylesheet"> <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries --> <!--[if lt IE 9]> @@ -29,7 +29,7 @@ <div class="container theme-showcase" role="main"> <div class="masthead"> <p class="lead"> - <a href="https://asterixdb.incubator.apache.org/index.html";><img src="https://asterixdb.incubator.apache.org/img/asterixdb.png"; style="height:75px; width:auto; vertical-align:bottom; margin-top:10px;"/></a> + <a href="index.html"><img src="img/asterixdb.png" style="height:75px; width:auto; vertical-align:bottom; margin-top:10px;"/></a> </p> </div> @@ -42,11 +42,11 @@ <span class="icon-bar"></span> <span class="icon-bar"></span> </button> - <a class="navbar-brand" href="https://asterixdb.incubator.apache.org/index.html";>Overview</a> + <a class="navbar-brand" href="index.html">Overview</a> </div> <div class="navbar-collapse collapse"> <ul class="nav navbar-nav"> - <li><a href="https://asterixdb.incubator.apache.org/download.html";>Download</a></li> + <li><a href="download.html">Download</a></li> <li class="dropdown"> <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">Documentation<span class="caret"></span></a> <ul class="dropdown-menu" role="menu"> @@ -57,16 +57,17 @@ <li><a href="https://ci.apache.org/projects/asterixdb/index.html";>Documentation for 0.8.8-SNAPSHOT <i class="fa fa-external-link fa-sm"></i></a></li> </ul> </li> - <li><a href="https://asterixdb.incubator.apache.org/about.html";>About</a></li> - <li><a href="https://asterixdb.incubator.apache.org/community.html";>Community</a></li> + <li><a href="about.html">About</a></li> + <li><a href="community.html">Community</a></li> <li class="dropdown"> <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">Contributing <span class="caret"></span></a> <ul class="dropdown-menu" role="menu"> <li class="dropdown-header">For New Contributors</li> - <li><a href="https://asterixdb.incubator.apache.org/dev-setup.html";>Development Setup</a></li> + <li><a href="dev-setup.html">Development Setup</a></li> <li class="divider"></li> <li class="dropdown-header">For Committers</li> - <li><a href="https://asterixdb.incubator.apache.org/pushing.html";>Pushing changes</a></li> + <li><a href="pushing.html">Pushing changes</a></li> + <li><a href="site.html">Editing this site</a></li> </ul> </li> </ul> @@ -146,7 +147,7 @@ <p>Apache AsterixDB, Apache, and the Apache feather logo are trademarks of the Apache Software Foundation</p> </div> <div class="col-md-1 text-right"> - <img src="https://asterixdb.incubator.apache.org/img/egg-logo.png"; style="height:auto; width:200px; vertical-align:bottom;"/> + <img src="img/egg-logo.png" style="height:auto; width:200px; vertical-align:bottom;"/> </div> </div> </footer> @@ -157,6 +158,6 @@ ================================================== --> <!-- Placed at the end of the document so the pages load faster --> <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.2/jquery.min.js";></script> - <script src="https://asterixdb.incubator.apache.org/js/bootstrap.min.js";></script> + <script src="js/bootstrap.min.js"></script> </body> </html> diff --git a/content/site.html b/content/site.html new file mode 100644 index 0000000..83d41a7 --- /dev/null +++ b/content/site.html @@ -0,0 +1,186 @@ +<!DOCTYPE html> +<html lang="en"> + <head> + <meta charset="utf-8"> + <meta http-equiv="X-UA-Compatible" content="IE=edge"> + <meta name="viewport" content="width=device-width, initial-scale=1"> + <!-- The above 3 meta tags *must* come first in the head; any other head content must come *after* these tags --> + <meta name="description" content=""> + <meta name="author" content=""> + <link rel="icon" href="favicon.ico"> + + <title>Editing this website</title> + + <!-- Bootstrap core CSS --> + <link href="css/bootstrap.min.css" rel="stylesheet"> + <!-- Bootstrap theme --> + + <!-- Custom styles for this template --> + <link href="css/theme.css" rel="stylesheet"> + + <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries --> + <!--[if lt IE 9]> + <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js";></script> + <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js";></script> + <![endif]--> + <link rel="stylesheet" href="//maxcdn.bootstrapcdn.com/font-awesome/4.3.0/css/font-awesome.min.css"> + </head> + + <div class="container theme-showcase" role="main"> + <div class="masthead"> + <p class="lead"> + <a href="index.html"><img src="img/asterixdb.png" style="height:75px; width:auto; vertical-align:bottom; margin-top:10px;"/></a> + </p> +</div> + +<nav class="navbar navbar-default"> + <div class="container"> + <div class="navbar-header"> + <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target=".navbar-collapse"> + <span class="sr-only">Toggle navigation</span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + </button> + <a class="navbar-brand" href="index.html">Overview</a> + </div> + <div class="navbar-collapse collapse"> + <ul class="nav navbar-nav"> + <li><a href="download.html">Download</a></li> + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">Documentation<span class="caret"></span></a> + <ul class="dropdown-menu" role="menu"> + <li class="dropdown-header">Stable release</li> + <li><a href="docs/0.8.7-incubating/index.html">Documentation for 0.8.7-incubating<i class="fa fa-external-link fa-sm"></i></a></li> + <li class="divider"></li> + <li class="dropdown-header">Snapshot release</li> + <li><a href="https://ci.apache.org/projects/asterixdb/index.html";>Documentation for 0.8.8-SNAPSHOT <i class="fa fa-external-link fa-sm"></i></a></li> + </ul> + </li> + <li><a href="about.html">About</a></li> + <li><a href="community.html">Community</a></li> + <li class="dropdown"> + <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">Contributing <span class="caret"></span></a> + <ul class="dropdown-menu" role="menu"> + <li class="dropdown-header">For New Contributors</li> + <li><a href="dev-setup.html">Development Setup</a></li> + <li class="divider"></li> + <li class="dropdown-header">For Committers</li> + <li><a href="pushing.html">Pushing changes</a></li> + <li><a href="site.html">Editing this site</a></li> + </ul> + </li> + </ul> + </div><!--/.nav-collapse --> + </div> + </nav> + + + <div class="row"> +<div class="col-md-8 col-centered"> +<h2>Editing this website</h2> +<!-- Major credit to the Apache Flink guys for writing a great doc in a similar vein for their website +that happens to use more or less the same tooling as AsterixDB's. Much of this doc is based on it. --> + +<ul id="markdown-toc"> + <li><a href="#prerequisites" id="markdown-toc-prerequisites">Prerequisites</a> <ul> + <li><a href="#jekyll" id="markdown-toc-jekyll">Jekyll.</a></li> + <li><a href="#checking-out-the-website-sources" id="markdown-toc-checking-out-the-website-sources">Checking out the website sources</a></li> + </ul> + </li> + <li><a href="#making-a-change-to-the-site" id="markdown-toc-making-a-change-to-the-site">Making a change to the site</a> <ul> + <li><a href="#editing-and-viewing-the-change" id="markdown-toc-editing-and-viewing-the-change">Editing and viewing the change.</a></li> + <li><a href="#submitting-the-change-to-the-live-site" id="markdown-toc-submitting-the-change-to-the-live-site">Submitting the change to the live site</a></li> + </ul> + </li> +</ul> + +<hr /> + +<h2 id="prerequisites">Prerequisites</h2> + +<h3 id="jekyll">Jekyll.</h3> +<p>This website is written using a static website generator called <a href="https://github.com/jekyll/jekyll";>Jekyll</a>. To work with editing this website you will need to install it. +In short, Jekyll uses a combination of templated HTML files and Markdown to compile the final site. +Generally, the content itself lies withink the Markdown files, and the HTML is for layout. +A full tutorial about how to use Jekyll is out of the scope of this document, but, for our purposes, only Markdown will be edited.</p> + +<h3 id="checking-out-the-website-sources">Checking out the website sources</h3> + +<p>The website is managed using <code>git</code>. Clone the site as usual</p> + +<pre><code> ➤ git clone https://git-wip-us.apache.org/repos/asf/incubator-asterixdb-site.git +</code></pre> + +<p>You will notice lots of Markdown files and HTML templates in the repository root. The compiled content of the website itself is served from the <code>content/</code> folder in this repository. That is to say, that the actual content of the website itself, as well as its sources are stored in the same repository. Additionally, the main branch on this repository is <code>asf-site</code> and not <code>master</code>.</p> + +<p>Gerrit is used to submit code reviews for the website just as it is with the main codebase. The main difference the site is not strictly subject to code reviews.</p> + +<p>To add the Gerrit repository for this site, add it as a normal git remote:</p> + +<pre><code> ➤ git remote add gerrit ssh://[email protected]:29418/incubator-asterixdb-site +</code></pre> + +<h2 id="making-a-change-to-the-site">Making a change to the site</h2> + +<p>The general overview is as follows: +- Make edits and check the output of ‘jekyll build’ +- Commit the change and propose it for review +- Either wait for a review, or submit the change</p> + +<h3 id="editing-and-viewing-the-change">Editing and viewing the change.</h3> + +<p>For whichever section of the site you want to edit, go ahead and do so with the text editor of your choice. Then, to see what your change looks like, in the repository root, execute:</p> + +<pre><code> ➤ jekyll serve --watch --destination content/ +</code></pre> + +<p>This sets up a small integrated web server and compiles the site dynamically as it is edited. Once you are satisfied with how the site looks, go ahead and commit your changes with git.</p> + +<p>Right now git gerrit submit isn’t used for the website, so you must construct the proper commit for Gerrit by hand. In your commit message, be sure to include a Commit-Id footer that is unique to your change. You may take previous Commit-Id: footers as an example.</p> + +<p>Once you have made your commit, push it to Gerrit for review:</p> + +<pre><code> ➤ git push gerrit HEAD:refs/for/asf-site +</code></pre> + +<h3 id="submitting-the-change-to-the-live-site">Submitting the change to the live site</h3> + +<p>When the submitted review is committed in Gerrit, pull it and overwrite your current asf-site branch:</p> + +<pre><code> ➤ git pull gerrit +</code></pre> + +<p>Then, push the exact commit from the Gerrit web interface to the ASF git repository. Do this with care! ASF git doesn’t allow hard resets on branches, so whatever you push here is final.</p> + +<pre><code> ➤ git push origin (SHA1 of submitted commit) +</code></pre> + + +</div> +</div> + + + <hr /> + + <footer> + <div class="row"> + <div class="col-md-6 col-md-offset-3 text-center"> + <p>© Copyright 2015 The Apache Software foundation. All Rights Reserved. </p> + <p>Apache AsterixDB, Apache, and the Apache feather logo are trademarks of the Apache Software Foundation</p> + </div> + <div class="col-md-1 text-right"> + <img src="img/egg-logo.png" style="height:auto; width:200px; vertical-align:bottom;"/> + </div> + </div> + </footer> + </div> <!-- /container --> + + + <!-- Bootstrap core JavaScript + ================================================== --> + <!-- Placed at the end of the document so the pages load faster --> + <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.2/jquery.min.js";></script> + <script src="js/bootstrap.min.js"></script> + </body> +</html> diff --git a/content/tools.html b/content/tools.html index 92500b8..0d85a92 100644 --- a/content/tools.html +++ b/content/tools.html @@ -7,16 +7,16 @@ <!-- The above 3 meta tags *must* come first in the head; any other head content must come *after* these tags --> <meta name="description" content=""> <meta name="author" content=""> - <link rel="icon" href="https://asterixdb.incubator.apache.org/favicon.ico";> + <link rel="icon" href="favicon.ico"> <title>Tools</title> <!-- Bootstrap core CSS --> - <link href="https://asterixdb.incubator.apache.org/css/bootstrap.min.css"; rel="stylesheet"> + <link href="css/bootstrap.min.css" rel="stylesheet"> <!-- Bootstrap theme --> <!-- Custom styles for this template --> - <link href="https://asterixdb.incubator.apache.org/css/theme.css"; rel="stylesheet"> + <link href="css/theme.css" rel="stylesheet"> <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries --> <!--[if lt IE 9]> @@ -29,7 +29,7 @@ <div class="container theme-showcase" role="main"> <div class="masthead"> <p class="lead"> - <a href="https://asterixdb.incubator.apache.org/index.html";><img src="https://asterixdb.incubator.apache.org/img/asterixdb.png"; style="height:75px; width:auto; vertical-align:bottom; margin-top:10px;"/></a> + <a href="index.html"><img src="img/asterixdb.png" style="height:75px; width:auto; vertical-align:bottom; margin-top:10px;"/></a> </p> </div> @@ -42,11 +42,11 @@ <span class="icon-bar"></span> <span class="icon-bar"></span> </button> - <a class="navbar-brand" href="https://asterixdb.incubator.apache.org/index.html";>Overview</a> + <a class="navbar-brand" href="index.html">Overview</a> </div> <div class="navbar-collapse collapse"> <ul class="nav navbar-nav"> - <li><a href="https://asterixdb.incubator.apache.org/download.html";>Download</a></li> + <li><a href="download.html">Download</a></li> <li class="dropdown"> <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">Documentation<span class="caret"></span></a> <ul class="dropdown-menu" role="menu"> @@ -57,16 +57,17 @@ <li><a href="https://ci.apache.org/projects/asterixdb/index.html";>Documentation for 0.8.8-SNAPSHOT <i class="fa fa-external-link fa-sm"></i></a></li> </ul> </li> - <li><a href="https://asterixdb.incubator.apache.org/about.html";>About</a></li> - <li><a href="https://asterixdb.incubator.apache.org/community.html";>Community</a></li> + <li><a href="about.html">About</a></li> + <li><a href="community.html">Community</a></li> <li class="dropdown"> <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">Contributing <span class="caret"></span></a> <ul class="dropdown-menu" role="menu"> <li class="dropdown-header">For New Contributors</li> - <li><a href="https://asterixdb.incubator.apache.org/dev-setup.html";>Development Setup</a></li> + <li><a href="dev-setup.html">Development Setup</a></li> <li class="divider"></li> <li class="dropdown-header">For Committers</li> - <li><a href="https://asterixdb.incubator.apache.org/pushing.html";>Pushing changes</a></li> + <li><a href="pushing.html">Pushing changes</a></li> + <li><a href="site.html">Editing this site</a></li> </ul> </li> </ul> @@ -87,7 +88,7 @@ <h3 id="apache-tools">Apache Tools</h3> <p>|———————————————————————————–|——————-| -|<img src="https://asterixdb.incubator.apache.org//img/tools/maven.png"; height="100" /> | |</p> +|<img src="/img/tools/maven.png" height="100" /> | |</p> <hr /> <h4 id="open-source-tools">Open Source Tools</h4> @@ -95,11 +96,11 @@ <table class="table table-striped"> <tbody> <tr> - <td><img src="https://asterixdb.incubator.apache.org//img/tools/jenkins.png"; height="100" /></td> + <td><img src="/img/tools/jenkins.png" height="100" /></td> <td> </td> </tr> <tr> - <td><img src="https://asterixdb.incubator.apache.org//img/tools/gerrit.png"; height="100" /></td> + <td><img src="/img/tools/gerrit.png" height="100" /></td> <td>Gerrit is used by the majority of developers as a staging repository for new changes and as a code review tool</td> </tr> </tbody> @@ -112,11 +113,11 @@ <table class="table table-striped"> <tbody> <tr> - <td><img src="https://asterixdb.incubator.apache.org//img/tools/yourkit.png"; height="100" /></td> + <td><img src="/img/tools/yourkit.png" height="100" /></td> <td>YourKit whenever a hard to</td> </tr> <tr> - <td><img src="https://asterixdb.incubator.apache.org//img/tools/intellij.png"; height="100" /></td> + <td><img src="/img/tools/intellij.png" height="100" /></td> <td> </td> </tr> </tbody> @@ -135,7 +136,7 @@ <p>Apache AsterixDB, Apache, and the Apache feather logo are trademarks of the Apache Software Foundation</p> </div> <div class="col-md-1 text-right"> - <img src="https://asterixdb.incubator.apache.org/img/egg-logo.png"; style="height:auto; width:200px; vertical-align:bottom;"/> + <img src="img/egg-logo.png" style="height:auto; width:200px; vertical-align:bottom;"/> </div> </div> </footer> @@ -146,6 +147,6 @@ ================================================== --> <!-- Placed at the end of the document so the pages load faster --> <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.2/jquery.min.js";></script> - <script src="https://asterixdb.incubator.apache.org/js/bootstrap.min.js";></script> + <script src="js/bootstrap.min.js"></script> </body> </html> diff --git a/site.md b/site.md new file mode 100644 index 0000000..f4667a8 --- /dev/null +++ b/site.md @@ -0,0 +1,70 @@ +--- +title: Editing this website +--- + +<!-- Major credit to the Apache Flink guys for writing a great doc in a similar vein for their website +that happens to use more or less the same tooling as AsterixDB's. Much of this doc is based on it. --> + +* TOC +{:toc} + +--- + +## Prerequisites + +### Jekyll. +This website is written using a static website generator called [Jekyll](https://github.com/jekyll/jekyll). To work with editing this website you will need to install it. +In short, Jekyll uses a combination of templated HTML files and Markdown to compile the final site. +Generally, the content itself lies withink the Markdown files, and the HTML is for layout. +A full tutorial about how to use Jekyll is out of the scope of this document, but, for our purposes, only Markdown will be edited. + +### Checking out the website sources + +The website is managed using `git`. Clone the site as usual + + ➤ git clone https://git-wip-us.apache.org/repos/asf/incubator-asterixdb-site.git + +You will notice lots of Markdown files and HTML templates in the repository root. The compiled content of the website itself is served from the `content/` folder in this repository. That is to say, that the actual content of the website itself, as well as its sources are stored in the same repository. Additionally, the main branch on this repository is `asf-site` and not `master`. + +Gerrit is used to submit code reviews for the website just as it is with the main codebase. The main difference the site is not strictly subject to code reviews. + +To add the Gerrit repository for this site, add it as a normal git remote: + + ➤ git remote add gerrit ssh://[email protected]:29418/incubator-asterixdb-site + + +## Making a change to the site + +The general overview is as follows: +- Make edits and check the output of 'jekyll build' +- Commit the change and propose it for review +- Either wait for a review, or submit the change + +### Editing and viewing the change. + +For whichever section of the site you want to edit, go ahead and do so with the text editor of your choice. Then, to see what your change looks like, in the repository root, execute: + + + ➤ jekyll serve --watch --destination content/ + + +This sets up a small integrated web server and compiles the site dynamically as it is edited. Once you are satisfied with how the site looks, go ahead and commit your changes with git. + +Right now git gerrit submit isn't used for the website, so you must construct the proper commit for Gerrit by hand. In your commit message, be sure to include a Commit-Id footer that is unique to your change. You may take previous Commit-Id: footers as an example. + +Once you have made your commit, push it to Gerrit for review: + + ➤ git push gerrit HEAD:refs/for/asf-site + +### Submitting the change to the live site + +When the submitted review is committed in Gerrit, pull it and overwrite your current asf-site branch: + + ➤ git pull gerrit + +Then, push the exact commit from the Gerrit web interface to the ASF git repository. Do this with care! ASF git doesn't allow hard resets on branches, so whatever you push here is final. + + + ➤ git push origin (SHA1 of submitted commit) + + -- To view, visit https://asterix-gerrit.ics.uci.edu/541 To unsubscribe, visit https://asterix-gerrit.ics.uci.edu/settings Gerrit-MessageType: newchange Gerrit-Change-Id: Iadb5074e130d4a42b2af123fa405e9fc21a14aed Gerrit-PatchSet: 1 Gerrit-Project: incubator-asterixdb-site Gerrit-Branch: asf-site Gerrit-Owner: Ian Maxon <[email protected]>
![https://asterixdb.incubator.apache.org/img/asterixdb.png"](https://asterixdb.incubator.apache.org/img/asterixdb.png"){kind=link}
![https://asterixdb.incubator.apache.org/img/egg-logo.png"](https://asterixdb.incubator.apache.org/img/egg-logo.png"){kind=link}
![https://asterixdb.incubator.apache.org//img/team/michael_carey.jpg"](https://asterixdb.incubator.apache.org//img/team/michael_carey.jpg"){kind=link}
![https://asterixdb.incubator.apache.org//img/team/till_westmann.jpg"](https://asterixdb.incubator.apache.org//img/team/till_westmann.jpg"){kind=link}
![https://asterixdb.incubator.apache.org//img/team/vinayak_borkar.jpg"](https://asterixdb.incubator.apache.org//img/team/vinayak_borkar.jpg"){kind=link}
![https://asterixdb.incubator.apache.org//img/team/vassilis_tsotras.jpg"](https://asterixdb.incubator.apache.org//img/team/vassilis_tsotras.jpg"){kind=link}
![https://asterixdb.incubator.apache.org//img/team/chen_li.jpg"](https://asterixdb.incubator.apache.org//img/team/chen_li.jpg"){kind=link}
![https://asterixdb.incubator.apache.org//img/team/yingyi_bu.jpg"](https://asterixdb.incubator.apache.org//img/team/yingyi_bu.jpg"){kind=link}
![https://asterixdb.incubator.apache.org//img/team/young_seok_kim.jpg"](https://asterixdb.incubator.apache.org//img/team/young_seok_kim.jpg"){kind=link}
![https://asterixdb.incubator.apache.org//img/team/inci_cetindil.jpg"](https://asterixdb.incubator.apache.org//img/team/inci_cetindil.jpg"){kind=link}
![https://asterixdb.incubator.apache.org//img/team/raman_grover.jpg"](https://asterixdb.incubator.apache.org//img/team/raman_grover.jpg"){kind=link}
![https://asterixdb.incubator.apache.org//img/team/pouria_pirzadeh.jpg"](https://asterixdb.incubator.apache.org//img/team/pouria_pirzadeh.jpg"){kind=link}
![https://asterixdb.incubator.apache.org//img/team/murtadha_hubail.jpg"](https://asterixdb.incubator.apache.org//img/team/murtadha_hubail.jpg"){kind=link}
![https://asterixdb.incubator.apache.org//img/team/ian_maxon.jpg"](https://asterixdb.incubator.apache.org//img/team/ian_maxon.jpg"){kind=link}
![https://asterixdb.incubator.apache.org//img/team/jianfeng_jia.jpg"](https://asterixdb.incubator.apache.org//img/team/jianfeng_jia.jpg"){kind=link}
![https://asterixdb.incubator.apache.org//img/team/taewoo_kim.jpg"](https://asterixdb.incubator.apache.org//img/team/taewoo_kim.jpg"){kind=link}
![https://asterixdb.incubator.apache.org//img/team/anonymous.jpg"](https://asterixdb.incubator.apache.org//img/team/anonymous.jpg"){kind=link}
![https://asterixdb.incubator.apache.org//img/team/sattam_alsubaiee.png"](https://asterixdb.incubator.apache.org//img/team/sattam_alsubaiee.png"){kind=link}
![https://asterixdb.incubator.apache.org//img/team/steven_jacobs.jpg"](https://asterixdb.incubator.apache.org//img/team/steven_jacobs.jpg"){kind=link}
![https://asterixdb.incubator.apache.org//img/team/ildar_absalyamov.jpg"](https://asterixdb.incubator.apache.org//img/team/ildar_absalyamov.jpg"){kind=link}
![https://asterixdb.incubator.apache.org//img/team/abdullah_alamoudi.jpg"](https://asterixdb.incubator.apache.org//img/team/abdullah_alamoudi.jpg"){kind=link}
![https://asterixdb.incubator.apache.org//img/team/zachary_heilbron.jpg"](https://asterixdb.incubator.apache.org//img/team/zachary_heilbron.jpg"){kind=link}
![https://asterixdb.incubator.apache.org//img/team/keren_ouaknine.jpg"](https://asterixdb.incubator.apache.org//img/team/keren_ouaknine.jpg"){kind=link}
![https://asterixdb.incubator.apache.org//img/team/chris_hillery.jpg"](https://asterixdb.incubator.apache.org//img/team/chris_hillery.jpg"){kind=link}
![https://asterixdb.incubator.apache.org//img/team/eugenia_gabrielova.jpg"](https://asterixdb.incubator.apache.org//img/team/eugenia_gabrielova.jpg"){kind=link}
![https://asterixdb.incubator.apache.org//img/team/heri_ramampiaro.jpg"](https://asterixdb.incubator.apache.org//img/team/heri_ramampiaro.jpg"){kind=link}
![https://asterixdb.incubator.apache.org//img/tools/maven.png"](https://asterixdb.incubator.apache.org//img/tools/maven.png"){kind=link}
![https://asterixdb.incubator.apache.org//img/tools/jenkins.png"](https://asterixdb.incubator.apache.org//img/tools/jenkins.png"){kind=link}
![https://asterixdb.incubator.apache.org//img/tools/gerrit.png"](https://asterixdb.incubator.apache.org//img/tools/gerrit.png"){kind=link}
![https://asterixdb.incubator.apache.org//img/tools/yourkit.png"](https://asterixdb.incubator.apache.org//img/tools/yourkit.png"){kind=link}
![https://asterixdb.incubator.apache.org//img/tools/intellij.png"](https://asterixdb.incubator.apache.org//img/tools/intellij.png"){kind=link}