Gitiles
Code Review Sign In
asterix-gerrit.ics.uci.edu / incubator-asterixdb-site / d00eca8943db0c3998464456a3b3f2f633b1c333 / . / content / site.html
blob: 2930b41eb9df1dc8be867a7e412420f4b4d761c2 [file] [log] [blame]
Ian Maxonf84cb812015-12-07 15:09:45 -0800[diff] [blame]1<!DOCTYPE html>
2<html lang="en">
3 <head>
4 <meta charset="utf-8">
5 <meta http-equiv="X-UA-Compatible" content="IE=edge">
6 <meta name="viewport" content="width=device-width, initial-scale=1">
7 <!-- The above 3 meta tags *must* come first in the head; any other head content must come *after* these tags -->
8 <meta name="description" content="">
9 <meta name="author" content="">
10 <link rel="icon" href="favicon.ico">
11
12 <title>Editing this website</title>
13
14 <!-- Bootstrap core CSS -->
15 <link href="css/bootstrap.min.css" rel="stylesheet">
16 <!-- Bootstrap theme -->
17
18 <!-- Custom styles for this template -->
19 <link href="css/theme.css" rel="stylesheet">
20
21 <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
22 <!--[if lt IE 9]>
23 <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
24 <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
25 <![endif]-->
26 <link rel="stylesheet" href="//maxcdn.bootstrapcdn.com/font-awesome/4.3.0/css/font-awesome.min.css">
27 </head>
28
29 <div class="container theme-showcase" role="main">
Till Westmann00f9bf22016-03-14 13:59:27 -0700[diff] [blame]30 <div class="masthead">
31 <p class="lead">
32 <a href="index.html">
33 <img src="img/asterixdb_tm.png" style="height:75px; width:auto; vertical-align:bottom; margin-top:10px;"/>
34 </a>
35 </p>
36 </div>
Ian Maxonf84cb812015-12-07 15:09:45 -0800[diff] [blame]37
Till Westmann00f9bf22016-03-14 13:59:27 -0700[diff] [blame]38 <nav class="navbar navbar-default">
Ian Maxonf84cb812015-12-07 15:09:45 -0800[diff] [blame]39 <div class="container">
40 <div class="navbar-header">
41 <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target=".navbar-collapse">
42 <span class="sr-only">Toggle navigation</span>
43 <span class="icon-bar"></span>
44 <span class="icon-bar"></span>
45 <span class="icon-bar"></span>
46 </button>
47 <a class="navbar-brand" href="index.html">Overview</a>
48 </div>
49 <div class="navbar-collapse collapse">
50 <ul class="nav navbar-nav">
51 <li><a href="download.html">Download</a></li>
52 <li class="dropdown">
53 <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">Documentation<span class="caret"></span></a>
54 <ul class="dropdown-menu" role="menu">
55 <li class="dropdown-header">Stable release</li>
Ian Maxond00eca82018-10-05 17:29:55 -0700[diff] [blame^]56 <li><a href="docs/0.9.4/index.html">Documentation for 0.9.4<i class="fa fa-external-link fa-sm"></i></a></li>
Ian Maxonf84cb812015-12-07 15:09:45 -0800[diff] [blame]57 <li class="divider"></li>
58 <li class="dropdown-header">Snapshot release</li>
Ian Maxond00eca82018-10-05 17:29:55 -0700[diff] [blame^]59 <li><a href="https://ci.apache.org/projects/asterixdb/index.html">Documentation for 0.9.5-SNAPSHOT <i class="fa fa-external-link fa-sm"></i></a></li>
Ian Maxonf84cb812015-12-07 15:09:45 -0800[diff] [blame]60 </ul>
61 </li>
62 <li><a href="about.html">About</a></li>
Till Westmann2a321022016-04-08 08:18:14 -0700[diff] [blame]63 <li class="dropdown">
64 <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">Community<span class="caret"></span></a>
65 <ul class="dropdown-menu" role="menu">
66 <li><a href="community.html">Mailing Lists</a></li>
67 <li><a href="community.html#irc">IRC</a></li>
68 <li><a href="community.html#asterixdb-team">Team</a></li>
69 <li><a href="https://issues.apache.org/jira/browse/ASTERIXDB">Issue Tracker</a></li>
70 </ul>
71 </li>
Ian Maxonf84cb812015-12-07 15:09:45 -0800[diff] [blame]72 <li class="dropdown">
Michael Blowf93d7f52016-10-07 14:36:30 -0400[diff] [blame]73 <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">Development<span class="caret"></span></a>
Ian Maxonf84cb812015-12-07 15:09:45 -0800[diff] [blame]74 <ul class="dropdown-menu" role="menu">
75 <li class="dropdown-header">For New Contributors</li>
76 <li><a href="dev-setup.html">Development Setup</a></li>
77 <li class="divider"></li>
78 <li class="dropdown-header">For Committers</li>
79 <li><a href="pushing.html">Pushing changes</a></li>
80 <li><a href="site.html">Editing this site</a></li>
Michael Blowf93d7f52016-10-07 14:36:30 -0400[diff] [blame]81 <li class="dropdown-header">Extensions</li>
82 <li><a href="extension.html">Extending AsterixDB</a></li>
Ian Maxonf84cb812015-12-07 15:09:45 -0800[diff] [blame]83 </ul>
84 </li>
85 </ul>
Till Westmann00f9bf22016-03-14 13:59:27 -0700[diff] [blame]86 <ul class="nav navbar-nav navbar-right">
87 <li class="dropdown">
88 <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false"
89 style="padding-right: 30px">
90 <img src="img/feather.png" style="height:20px"/>Apache Software Foundation<span class="caret"/>
91 </a>
92 <ul class="dropdown-menu dropdown-menu-right" role="menu">
93 <li><a href="http://www.apache.org/"><b>ASF Homepage</b></a></li>
94 <li><a href="http://www.apache.org/licenses/">License</a></li>
95 <li><a href="http://www.apache.org/foundation/sponsorship.html">Donate</a></li>
96 <li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li>
97 <li><a href="http://www.apache.org/security/">Security</a></li>
98 </ul>
99 </li>
100 </ul>
Ian Maxonf84cb812015-12-07 15:09:45 -0800[diff] [blame]101 </div><!--/.nav-collapse -->
102 </div>
103 </nav>
104
105
Till Westmann00f9bf22016-03-14 13:59:27 -0700[diff] [blame]106 <div class="row">
Ian Maxonf84cb812015-12-07 15:09:45 -0800[diff] [blame]107<div class="col-md-8 col-centered">
108<h2>Editing this website</h2>
109<!-- Major credit to the Apache Flink guys for writing a great doc in a similar vein for their website
110that happens to use more or less the same tooling as AsterixDB's. Much of this doc is based on it. -->
111
112<ul id="markdown-toc">
113 <li><a href="#prerequisites" id="markdown-toc-prerequisites">Prerequisites</a> <ul>
114 <li><a href="#jekyll" id="markdown-toc-jekyll">Jekyll.</a></li>
115 <li><a href="#checking-out-the-website-sources" id="markdown-toc-checking-out-the-website-sources">Checking out the website sources</a></li>
116 </ul>
117 </li>
118 <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>
119 <li><a href="#editing-and-viewing-the-change" id="markdown-toc-editing-and-viewing-the-change">Editing and viewing the change.</a></li>
120 <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>
121 </ul>
122 </li>
Till Westmannabfde422016-02-29 18:57:58 -0800[diff] [blame]123 <li><a href="#troubleshooting" id="markdown-toc-troubleshooting">Troubleshooting</a></li>
Ian Maxonf84cb812015-12-07 15:09:45 -0800[diff] [blame]124</ul>
125
126<hr />
127
128<h2 id="prerequisites">Prerequisites</h2>
129
130<h3 id="jekyll">Jekyll.</h3>
131<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.
132In short, Jekyll uses a combination of templated HTML files and Markdown to compile the final site.
133Generally, the content itself lies within the Markdown files, and the HTML is for layout.
134A 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>
135
136<h3 id="checking-out-the-website-sources">Checking out the website sources</h3>
137
138<p>The website is managed using <code>git</code>. Clone the site as usual</p>
139
Till Westmannc6e439f2016-07-07 14:45:57 -0700[diff] [blame]140<pre><code>➤ git clone -b asf-site https://git-wip-us.apache.org/repos/asf/asterixdb-site.git
Till Westmann1dba8882016-02-29 15:44:42 -0800[diff] [blame]141</code></pre>
142
143<p>and <code>cd</code> into the clone</p>
144
Till Westmannc6e439f2016-07-07 14:45:57 -0700[diff] [blame]145<pre><code>➤ cd asterixdb-site
Ian Maxonf84cb812015-12-07 15:09:45 -0800[diff] [blame]146</code></pre>
147
148<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>
149
150<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>
151
Till Westmann1dba8882016-02-29 15:44:42 -0800[diff] [blame]152<p>Then, you likely will want to check out to make your own topic branch as to not work directly on the “live” branch, like so:</p>
Ian Maxonf84cb812015-12-07 15:09:45 -0800[diff] [blame]153
Till Westmannabfde422016-02-29 18:57:58 -0800[diff] [blame]154<pre><code>➤ git checkout -b YOU/site
Till Westmann1dba8882016-02-29 15:44:42 -0800[diff] [blame]155</code></pre>
156
157<p>And perform the git-gerrit init on this branch</p>
158
Till Westmannabfde422016-02-29 18:57:58 -0800[diff] [blame]159<pre><code>➤ git gerrit init -u ssh://YOU@asterix-gerrit.ics.uci.edu:29418/ -p incubator-asterixdb-site
Ian Maxonf84cb812015-12-07 15:09:45 -0800[diff] [blame]160</code></pre>
161
162<h2 id="making-a-change-to-the-site">Making a change to the site</h2>
163
Till Westmann1dba8882016-02-29 15:44:42 -0800[diff] [blame]164<p>The general overview is as follows:</p>
165
166<ul>
167 <li>Make edits and check the output of <code>jekyll build</code></li>
168 <li>Commit the change and propose it for review</li>
169 <li>Either wait for a review, or submit the change</li>
170</ul>
Ian Maxonf84cb812015-12-07 15:09:45 -0800[diff] [blame]171
172<h3 id="editing-and-viewing-the-change">Editing and viewing the change.</h3>
173
174<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>
175
Till Westmannabfde422016-02-29 18:57:58 -0800[diff] [blame]176<pre><code>➤ jekyll serve --watch
Ian Maxonf84cb812015-12-07 15:09:45 -0800[diff] [blame]177</code></pre>
178
179<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>
180
Ian Maxonf84cb812015-12-07 15:09:45 -0800[diff] [blame]181<p>Once you have made your commit, push it to Gerrit for review:</p>
182
Till Westmannabfde422016-02-29 18:57:58 -0800[diff] [blame]183<pre><code>➤ git gerrit submit -b asf-site
Ian Maxonf84cb812015-12-07 15:09:45 -0800[diff] [blame]184</code></pre>
185
Till Westmann1dba8882016-02-29 15:44:42 -0800[diff] [blame]186<p>For longer edits you might need to update your local <code>asf-site</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>. Similar to the way this is done for code changes you can use</p>
187
Till Westmannabfde422016-02-29 18:57:58 -0800[diff] [blame]188<pre><code>➤ git gerrit update -b asf-site
Till Westmann1dba8882016-02-29 15:44:42 -0800[diff] [blame]189</code></pre>
190
191<p>to do this.</p>
Ian Maxonf84cb812015-12-07 15:09:45 -0800[diff] [blame]192
193<h3 id="submitting-the-change-to-the-live-site">Submitting the change to the live site</h3>
194
195<p>When the submitted review is committed in Gerrit, pull it and overwrite your current asf-site branch:</p>
196
Till Westmannabfde422016-02-29 18:57:58 -0800[diff] [blame]197<pre><code>➤ git fetch gerrit
Ian Maxonf84cb812015-12-07 15:09:45 -0800[diff] [blame]198</code></pre>
199
200<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>
201
Till Westmannabfde422016-02-29 18:57:58 -0800[diff] [blame]202<pre><code>➤ git push origin (SHA1 of submitted commit):asf-site
203</code></pre>
204
205<h2 id="troubleshooting">Troubleshooting</h2>
206
207<p>If jekyll produces an error message like this one:</p>
208
209<pre><code>➤ jekyll serve --watch
Till Westmannc6e439f2016-07-07 14:45:57 -0700[diff] [blame]210Configuration file: /.../asterixdb-site/_config.yml
Till Westmannabfde422016-02-29 18:57:58 -0800[diff] [blame]211You are missing a library required for syntax highlighting. Please run:
212$ [sudo] gem install pygments
213jekyll 3.1.2 | Error: uninitialized constant Kramdown::Converter::PygmentsHtml::FatalException
214</code></pre>
215
216<p>this might fix it:</p>
217
218<pre><code>➤ sudo gem install pygments.rb
Ian Maxonf84cb812015-12-07 15:09:45 -0800[diff] [blame]219</code></pre>
220
221
222</div>
223</div>
224
225
Till Westmann00f9bf22016-03-14 13:59:27 -0700[diff] [blame]226 <hr/>
Ian Maxonf84cb812015-12-07 15:09:45 -0800[diff] [blame]227
Till Westmann00f9bf22016-03-14 13:59:27 -0700[diff] [blame]228 <footer>
229 <div class="row">
Till Westmann00f9bf22016-03-14 13:59:27 -0700[diff] [blame]230 <div class="col-md-9 col-centered text-center">
231 <p/>
232 <p>&copy; Copyright 2016 The Apache Software foundation. All Rights Reserved. </p>
233 <p>Apache AsterixDB, the Apache AsterixDB logo, Apache, and the Apache feather logo are trademarks of the
234 Apache Software Foundation</p>
Ian Maxonf84cb812015-12-07 15:09:45 -0800[diff] [blame]235 </div>
Till Westmann00f9bf22016-03-14 13:59:27 -0700[diff] [blame]236 </div>
237 </footer>
238 </div> <!-- /container -->
Ian Maxonf84cb812015-12-07 15:09:45 -0800[diff] [blame]239
240 <!-- Bootstrap core JavaScript
241 ================================================== -->
242 <!-- Placed at the end of the document so the pages load faster -->
243 <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script>
244 <script src="js/bootstrap.min.js"></script>
245 </body>
246</html>