Gitiles
Code Review Sign In
asterix-gerrit.ics.uci.edu / incubator-asterixdb-site / 00f9bf22dd19e8645315fb2b139527a575dae9c1 / . / content / site.html
blob: f6d603b1e1e5316456faf55fde7946c53097646a [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>
Till Westmanne617e522016-02-29 12:42:51 -0800[diff] [blame]56 <li><a href="docs/0.8.8-incubating/index.html">Documentation for 0.8.8-incubating<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>
59 <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>
60 </ul>
61 </li>
62 <li><a href="about.html">About</a></li>
63 <li><a href="community.html">Community</a></li>
64 <li class="dropdown">
65 <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">Contributing <span class="caret"></span></a>
66 <ul class="dropdown-menu" role="menu">
67 <li class="dropdown-header">For New Contributors</li>
68 <li><a href="dev-setup.html">Development Setup</a></li>
69 <li class="divider"></li>
70 <li class="dropdown-header">For Committers</li>
71 <li><a href="pushing.html">Pushing changes</a></li>
72 <li><a href="site.html">Editing this site</a></li>
73 </ul>
74 </li>
75 </ul>
Till Westmann00f9bf22016-03-14 13:59:27 -0700[diff] [blame^]76 <ul class="nav navbar-nav navbar-right">
77 <li class="dropdown">
78 <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false"
79 style="padding-right: 30px">
80 <img src="img/feather.png" style="height:20px"/>Apache Software Foundation<span class="caret"/>
81 </a>
82 <ul class="dropdown-menu dropdown-menu-right" role="menu">
83 <li><a href="http://www.apache.org/"><b>ASF Homepage</b></a></li>
84 <li><a href="http://www.apache.org/licenses/">License</a></li>
85 <li><a href="http://www.apache.org/foundation/sponsorship.html">Donate</a></li>
86 <li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li>
87 <li><a href="http://www.apache.org/security/">Security</a></li>
88 </ul>
89 </li>
90 </ul>
Ian Maxonf84cb812015-12-07 15:09:45 -0800[diff] [blame]91 </div><!--/.nav-collapse -->
92 </div>
93 </nav>
94
95
Till Westmann00f9bf22016-03-14 13:59:27 -0700[diff] [blame^]96 <div class="row">
Ian Maxonf84cb812015-12-07 15:09:45 -0800[diff] [blame]97<div class="col-md-8 col-centered">
98<h2>Editing this website</h2>
99<!-- Major credit to the Apache Flink guys for writing a great doc in a similar vein for their website
100that happens to use more or less the same tooling as AsterixDB's. Much of this doc is based on it. -->
101
102<ul id="markdown-toc">
103 <li><a href="#prerequisites" id="markdown-toc-prerequisites">Prerequisites</a> <ul>
104 <li><a href="#jekyll" id="markdown-toc-jekyll">Jekyll.</a></li>
105 <li><a href="#checking-out-the-website-sources" id="markdown-toc-checking-out-the-website-sources">Checking out the website sources</a></li>
106 </ul>
107 </li>
108 <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>
109 <li><a href="#editing-and-viewing-the-change" id="markdown-toc-editing-and-viewing-the-change">Editing and viewing the change.</a></li>
110 <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>
111 </ul>
112 </li>
Till Westmannabfde422016-02-29 18:57:58 -0800[diff] [blame]113 <li><a href="#troubleshooting" id="markdown-toc-troubleshooting">Troubleshooting</a></li>
Ian Maxonf84cb812015-12-07 15:09:45 -0800[diff] [blame]114</ul>
115
116<hr />
117
118<h2 id="prerequisites">Prerequisites</h2>
119
120<h3 id="jekyll">Jekyll.</h3>
121<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.
122In short, Jekyll uses a combination of templated HTML files and Markdown to compile the final site.
123Generally, the content itself lies within the Markdown files, and the HTML is for layout.
124A 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>
125
126<h3 id="checking-out-the-website-sources">Checking out the website sources</h3>
127
128<p>The website is managed using <code>git</code>. Clone the site as usual</p>
129
Till Westmannabfde422016-02-29 18:57:58 -0800[diff] [blame]130<pre><code>➤ git clone -b asf-site https://git-wip-us.apache.org/repos/asf/incubator-asterixdb-site.git
Till Westmann1dba8882016-02-29 15:44:42 -0800[diff] [blame]131</code></pre>
132
133<p>and <code>cd</code> into the clone</p>
134
Till Westmannabfde422016-02-29 18:57:58 -0800[diff] [blame]135<pre><code>➤ cd incubator-asterixdb-site
Ian Maxonf84cb812015-12-07 15:09:45 -0800[diff] [blame]136</code></pre>
137
138<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>
139
140<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>
141
Till Westmann1dba8882016-02-29 15:44:42 -0800[diff] [blame]142<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]143
Till Westmannabfde422016-02-29 18:57:58 -0800[diff] [blame]144<pre><code>➤ git checkout -b YOU/site
Till Westmann1dba8882016-02-29 15:44:42 -0800[diff] [blame]145</code></pre>
146
147<p>And perform the git-gerrit init on this branch</p>
148
Till Westmannabfde422016-02-29 18:57:58 -0800[diff] [blame]149<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]150</code></pre>
151
152<h2 id="making-a-change-to-the-site">Making a change to the site</h2>
153
Till Westmann1dba8882016-02-29 15:44:42 -0800[diff] [blame]154<p>The general overview is as follows:</p>
155
156<ul>
157 <li>Make edits and check the output of <code>jekyll build</code></li>
158 <li>Commit the change and propose it for review</li>
159 <li>Either wait for a review, or submit the change</li>
160</ul>
Ian Maxonf84cb812015-12-07 15:09:45 -0800[diff] [blame]161
162<h3 id="editing-and-viewing-the-change">Editing and viewing the change.</h3>
163
164<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>
165
Till Westmannabfde422016-02-29 18:57:58 -0800[diff] [blame]166<pre><code>➤ jekyll serve --watch
Ian Maxonf84cb812015-12-07 15:09:45 -0800[diff] [blame]167</code></pre>
168
169<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>
170
Ian Maxonf84cb812015-12-07 15:09:45 -0800[diff] [blame]171<p>Once you have made your commit, push it to Gerrit for review:</p>
172
Till Westmannabfde422016-02-29 18:57:58 -0800[diff] [blame]173<pre><code>➤ git gerrit submit -b asf-site
Ian Maxonf84cb812015-12-07 15:09:45 -0800[diff] [blame]174</code></pre>
175
Till Westmann1dba8882016-02-29 15:44:42 -0800[diff] [blame]176<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>
177
Till Westmannabfde422016-02-29 18:57:58 -0800[diff] [blame]178<pre><code>➤ git gerrit update -b asf-site
Till Westmann1dba8882016-02-29 15:44:42 -0800[diff] [blame]179</code></pre>
180
181<p>to do this.</p>
Ian Maxonf84cb812015-12-07 15:09:45 -0800[diff] [blame]182
183<h3 id="submitting-the-change-to-the-live-site">Submitting the change to the live site</h3>
184
185<p>When the submitted review is committed in Gerrit, pull it and overwrite your current asf-site branch:</p>
186
Till Westmannabfde422016-02-29 18:57:58 -0800[diff] [blame]187<pre><code>➤ git fetch gerrit
Ian Maxonf84cb812015-12-07 15:09:45 -0800[diff] [blame]188</code></pre>
189
190<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>
191
Till Westmannabfde422016-02-29 18:57:58 -0800[diff] [blame]192<pre><code>➤ git push origin (SHA1 of submitted commit):asf-site
193</code></pre>
194
195<h2 id="troubleshooting">Troubleshooting</h2>
196
197<p>If jekyll produces an error message like this one:</p>
198
199<pre><code>➤ jekyll serve --watch
200Configuration file: /.../incubator-asterixdb-site/_config.yml
201You are missing a library required for syntax highlighting. Please run:
202$ [sudo] gem install pygments
203jekyll 3.1.2 | Error: uninitialized constant Kramdown::Converter::PygmentsHtml::FatalException
204</code></pre>
205
206<p>this might fix it:</p>
207
208<pre><code>➤ sudo gem install pygments.rb
Ian Maxonf84cb812015-12-07 15:09:45 -0800[diff] [blame]209</code></pre>
210
211
212</div>
213</div>
214
215
Till Westmann00f9bf22016-03-14 13:59:27 -0700[diff] [blame^]216 <hr/>
Ian Maxonf84cb812015-12-07 15:09:45 -0800[diff] [blame]217
Till Westmann00f9bf22016-03-14 13:59:27 -0700[diff] [blame^]218 <footer>
219 <div class="row">
220 <div class="col-md-9 col-centered">
221 <div class="col-md-9 text-left">
222 <p>Apache AsterixDB is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored
223 by the Apache Incubator.
224 Incubation is required of all newly accepted projects until a further review indicates that the
225 infrastructure, communications, and decision making process have stabilized in a manner consistent with
226 other successful ASF projects.
227 While incubation status is not necessarily a reflection of the completeness or stability of the code, it
228 does indicate that the project has yet to be fully endorsed by the ASF.</p>
229 </div>
230 <div class="col-md-3 text-right">
231 <img src="img/egg-logo.png" style="height:auto; width:200px; vertical-align:bottom;"/>
232 </div>
233 </div>
234 </div>
235 <div class="row">
236 <div class="col-md-9 col-centered text-center">
237 <p/>
238 <p>&copy; Copyright 2016 The Apache Software foundation. All Rights Reserved. </p>
239 <p>Apache AsterixDB, the Apache AsterixDB logo, Apache, and the Apache feather logo are trademarks of the
240 Apache Software Foundation</p>
Ian Maxonf84cb812015-12-07 15:09:45 -0800[diff] [blame]241 </div>
Till Westmann00f9bf22016-03-14 13:59:27 -0700[diff] [blame^]242 </div>
243 </footer>
244 </div> <!-- /container -->
Ian Maxonf84cb812015-12-07 15:09:45 -0800[diff] [blame]245
246 <!-- Bootstrap core JavaScript
247 ================================================== -->
248 <!-- Placed at the end of the document so the pages load faster -->
249 <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script>
250 <script src="js/bootstrap.min.js"></script>
251 </body>
252</html>