asterixdb-notifications mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Till Westmann (Code Review)" <do-not-re...@asterixdb.incubator.apache.org>
Subject Change in incubator-asterixdb-site[asf-site]: troubleshooting + less indentation for commands
Date Tue, 01 Mar 2016 02:53:30 GMT
Till Westmann has uploaded a new change for review.

  https://asterix-gerrit.ics.uci.edu/684

Change subject: troubleshooting + less indentation for commands
......................................................................

troubleshooting + less indentation for commands

Change-Id: I21bbd0e448a40fd7bff437a29b6a628816ec6d7d
---
M content/site.html
M site.md
2 files changed, 49 insertions(+), 18 deletions(-)


  git pull ssh://asterix-gerrit.ics.uci.edu:29418/incubator-asterixdb-site refs/changes/84/684/1

diff --git a/content/site.html b/content/site.html
index 4c13db6..968b184 100644
--- a/content/site.html
+++ b/content/site.html
@@ -93,6 +93,7 @@
       <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>
+  <li><a href="#troubleshooting" id="markdown-toc-troubleshooting">Troubleshooting</a></li>
 </ul>
 
 <hr />
@@ -109,12 +110,12 @@
 
 <p>The website is managed using <code>git</code>. Clone the site as usual</p>
 
-<pre><code>     ➤ git clone -b asf-site https://git-wip-us.apache.org/repos/asf/incubator-asterixdb-site.git
+<pre><code>➤ git clone -b asf-site https://git-wip-us.apache.org/repos/asf/incubator-asterixdb-site.git
 </code></pre>
 
 <p>and <code>cd</code> into the clone</p>
 
-<pre><code>     ➤ cd incubator-asterixdb-site
+<pre><code>➤ cd incubator-asterixdb-site
 </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>
@@ -123,12 +124,12 @@
 
 <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>
 
-<pre><code>    ➤ git checkout -b YOU/site
+<pre><code>➤ git checkout -b YOU/site
 </code></pre>
 
 <p>And perform the git-gerrit init on this branch</p>
 
-<pre><code>    ➤ git gerrit init -u ssh://YOU@asterix-gerrit.ics.uci.edu:29418/
-p incubator-asterixdb-site
+<pre><code>➤ git gerrit init -u ssh://YOU@asterix-gerrit.ics.uci.edu:29418/
-p incubator-asterixdb-site
 </code></pre>
 
 <h2 id="making-a-change-to-the-site">Making a change to the site</h2>
@@ -145,19 +146,19 @@
 
 <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
+<pre><code>➤ jekyll serve --watch
 </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>Once you have made your commit, push it to Gerrit for review:</p>
 
-<pre><code>   ➤ git gerrit submit -b asf-site
+<pre><code>➤ git gerrit submit -b asf-site
 </code></pre>
 
 <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>
 
-<pre><code>   ➤ git gerrit update -b asf-site
+<pre><code>➤ git gerrit update -b asf-site
 </code></pre>
 
 <p>to do this.</p>
@@ -166,12 +167,28 @@
 
 <p>When the submitted review is committed in Gerrit, pull it and overwrite your current
asf-site branch:</p>
 
-<pre><code>   ➤ git fetch gerrit
+<pre><code>➤ git fetch 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):asf-site
+<pre><code>➤ git push origin (SHA1 of submitted commit):asf-site
+</code></pre>
+
+<h2 id="troubleshooting">Troubleshooting</h2>
+
+<p>If jekyll produces an error message like this one:</p>
+
+<pre><code>➤ jekyll serve --watch
+Configuration file: /.../incubator-asterixdb-site/_config.yml
+You are missing a library required for syntax highlighting. Please run:
+$ [sudo] gem install pygments
+jekyll 3.1.2 | Error:  uninitialized constant Kramdown::Converter::PygmentsHtml::FatalException
+</code></pre>
+
+<p>this might fix it:</p>
+
+<pre><code>➤ sudo gem install pygments.rb
 </code></pre>
 
 
diff --git a/site.md b/site.md
index 44aaaed..213aef1 100644
--- a/site.md
+++ b/site.md
@@ -22,11 +22,11 @@
 
 The website is managed using `git`. Clone the site as usual
 
-         ➤ git clone -b asf-site https://git-wip-us.apache.org/repos/asf/incubator-asterixdb-site.git
+    ➤ git clone -b asf-site https://git-wip-us.apache.org/repos/asf/incubator-asterixdb-site.git
 
 and `cd` into the clone
 
-         ➤ cd incubator-asterixdb-site
+    ➤ cd incubator-asterixdb-site
 
 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`
 
@@ -34,11 +34,11 @@
 
 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:
 
-        ➤ git checkout -b YOU/site
+    ➤ git checkout -b YOU/site
 
 And perform the git-gerrit init on this branch
 
-        ➤ git gerrit init -u ssh://YOU@asterix-gerrit.ics.uci.edu:29418/ -p incubator-asterixdb-site
+    ➤ git gerrit init -u ssh://YOU@asterix-gerrit.ics.uci.edu:29418/ -p incubator-asterixdb-site
 
 
 ## Making a change to the site
@@ -53,17 +53,17 @@
 
 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
+    ➤ jekyll serve --watch
 
 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.
 
 Once you have made your commit, push it to Gerrit for review:
 
-       ➤ git gerrit submit -b asf-site
+    ➤ git gerrit submit -b asf-site
 
 For longer edits you might need to update your local `asf-site` 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 `master`. Similar
to the way this is done for code changes you can use
 
-       ➤ git gerrit update -b asf-site
+    ➤ git gerrit update -b asf-site
 
 to do this.
 
@@ -71,9 +71,23 @@
 
 When the submitted review is committed in Gerrit, pull it and overwrite your current asf-site
branch:
 
-       ➤ git fetch gerrit
+    ➤ git fetch 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):asf-site
+    ➤ git push origin (SHA1 of submitted commit):asf-site
+
+## Troubleshooting
+
+If jekyll produces an error message like this one:
+
+    ➤ jekyll serve --watch
+    Configuration file: /.../incubator-asterixdb-site/_config.yml
+    You are missing a library required for syntax highlighting. Please run:
+    $ [sudo] gem install pygments
+    jekyll 3.1.2 | Error:  uninitialized constant Kramdown::Converter::PygmentsHtml::FatalException
+
+  this might fix it:
+
+    ➤ sudo gem install pygments.rb
 

-- 
To view, visit https://asterix-gerrit.ics.uci.edu/684
To unsubscribe, visit https://asterix-gerrit.ics.uci.edu/settings

Gerrit-MessageType: newchange
Gerrit-Change-Id: I21bbd0e448a40fd7bff437a29b6a628816ec6d7d
Gerrit-PatchSet: 1
Gerrit-Project: incubator-asterixdb-site
Gerrit-Branch: asf-site
Gerrit-Owner: Till Westmann <tillw@apache.org>

Mime
View raw message