incubator-odf-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From build...@apache.org
Subject svn commit: r846134 - in /websites/staging/odftoolkit/trunk/content: ./ odftoolkit/website-local.html
Date Fri, 11 Jan 2013 11:52:04 GMT
Author: buildbot
Date: Fri Jan 11 11:52:04 2013
New Revision: 846134

Log:
Staging update by buildbot for odftoolkit

Modified:
    websites/staging/odftoolkit/trunk/content/   (props changed)
    websites/staging/odftoolkit/trunk/content/odftoolkit/website-local.html

Propchange: websites/staging/odftoolkit/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Fri Jan 11 11:52:04 2013
@@ -1 +1 @@
-1430703
+1432004

Modified: websites/staging/odftoolkit/trunk/content/odftoolkit/website-local.html
==============================================================================
--- websites/staging/odftoolkit/trunk/content/odftoolkit/website-local.html (original)
+++ websites/staging/odftoolkit/trunk/content/odftoolkit/website-local.html Fri Jan 11 11:52:04
2013
@@ -107,54 +107,54 @@ repository</a> in your web browser.</p>
 <li><a href="#submitting_your_results">Submitting Your Results</a> - How
to contribute your edits.</li>
 </ul>
 <h2 id="setup">Setup</h2>
-<h3 id="create_a_directory_on_your_computer">Create a directory on your computer.</h3>
+<h3 id="create-a-directory-on-your-computer">Create a directory on your computer.</h3>
 <div class="codehilite"><pre><span class="nb">mkdir</span> <span
class="n">odf</span><span class="o">-</span><span class="n">site</span>
 <span class="n">cd</span> <span class="n">odf</span><span class="o">-</span><span
class="n">site</span>
 </pre></div>
 
 
-<h3 id="download_the_svn_repos_for_the_odf_site">Download the svn repos for the Odf
site.</h3>
+<h3 id="download-the-svn-repos-for-the-odf-site">Download the svn repos for the Odf
site.</h3>
 <div class="codehilite"><pre><span class="n">svn</span> <span
class="n">co</span> <span class="n">https:</span><span class="sr">//s</span><span
class="n">vn</span><span class="o">.</span><span class="n">apache</span><span
class="o">.</span><span class="n">org</span><span class="sr">/repos/</span><span
class="n">asf</span><span class="sr">/incubator/o</span><span class="n">df</span><span
class="sr">/site/</span><span class="n">trunk</span> <span class="n">site</span>
 </pre></div>
 
 
-<h3 id="download_the_svn_repos_for_the_apache_cms">Download the svn repos for the Apache
CMS.</h3>
+<h3 id="download-the-svn-repos-for-the-apache-cms">Download the svn repos for the Apache
CMS.</h3>
 <div class="codehilite"><pre><span class="n">svn</span> <span
class="n">co</span> <span class="n">https:</span><span class="sr">//s</span><span
class="n">vn</span><span class="o">.</span><span class="n">apache</span><span
class="o">.</span><span class="n">org</span><span class="sr">/repos/i</span><span
class="n">nfra</span><span class="sr">/websites/cms</span><span class="o">/</span>
<span class="n">cms</span>
 </pre></div>
 
 
-<h3 id="install_python_dependencies">Install Python dependencies.</h3>
+<h3 id="install-python-dependencies">Install Python dependencies.</h3>
 <p>Adapted from the <a href="http://www.apache.org/dev/cmsref.html#local-build">Apache
CMS Reference</a></p>
 <p>The easiest way to install the dependencies is to use Python setuptools.</p>
-<h4 id="check_your_version_of_python">Check your version of Python</h4>
+<h4 id="check-your-version-of-python">Check your version of Python</h4>
 <div class="codehilite"><pre><span class="n">python</span> <span
class="o">--</span><span class="n">version</span>
 </pre></div>
 
 
-<h4 id="follow_the_installation_instructions_for_setuptools4">Follow the installation
instructions for <a href="http://pypi.python.org/pypi/setuptools">setuptools</a>.</h4>
-<h4 id="install_dependencies">Install dependencies</h4>
+<h4 id="follow-the-installation-instructions-for-setuptools">Follow the installation
instructions for <a href="http://pypi.python.org/pypi/setuptools">setuptools</a>.</h4>
+<h4 id="install-dependencies">Install dependencies</h4>
 <div class="codehilite"><pre><span class="n">sudo</span> <span
class="n">easy_install</span> <span class="n">Pygments</span>
 <span class="n">sudo</span> <span class="n">easy_install</span> <span
class="n">ElementTree</span>
 <span class="n">sudo</span> <span class="n">easy_install</span> <span
class="n">Markdown</span>
 </pre></div>
 
 
-<h2 id="directory_layout">Directory Layout</h2>
-<h4 id="content_directory">Content directory</h4>
+<h2 id="directory-layout">Directory Layout</h2>
+<h4 id="content-directory">Content directory</h4>
 <p>The <code>site/content/odftoolkit</code> directory contains web content
- markdown, html, javascript, css, images and other files. Files that do not fit recognized
patterns from <code>site/lib/path.pm</code> are copied as is to the web site during
the build.</p>
-<h4 id="templates_directory">Templates directory</h4>
+<h4 id="templates-directory">Templates directory</h4>
 <p>The <code>site/templates</code> directory contains the html skeletons
used during the site build.</p>
 <ul>
 <li><code>skeleton.html</code> - our current html page template.</li>
 <li><code>sidenav.mdtext</code> - markdown of the side navigation panel.</li>
 </ul>
-<h4 id="lib_directory">Lib directory</h4>
+<h4 id="lib-directory">Lib directory</h4>
 <p>The <code>site/lib</code> directory contains two python modules that
determine how content files are processed during the site build.</p>
 <ul>
 <li><code>path.pm</code> - maps file patterns like <code>.mdtext</code>
into the view building routines. We can expand to cover other patterns.</li>
 <li><code>view.pm</code> - a set of python subroutines for converting content
into web pages.</li>
 </ul>
-<h4 id="build_tools">Build tools</h4>
+<h4 id="build-tools">Build tools</h4>
 <p>You can find the CMS build tools in the <code>cms</code> directory.</p>
 <ul>
 <li><code>cms/build/</code> - perl scripts for building the site and markdown
extensions.</li>
@@ -162,29 +162,35 @@ repository</a> in your web browser.</p>
 <li><code>cms/webgui/</code> - the webgui behind the <code>bookmarklet</code>.</li>
 </ul>
 <p>These can be extended locally. Before any changes become part of our process they
will need to be cleared with Apache Infrastructure. We'll need to submit patches. These should
be additive or be bug fixes.</p>
-<h2 id="local_development">Local Development</h2>
-<h3 id="edit_the_site">Edit the site</h3>
+<h2 id="local-development">Local Development</h2>
+<h3 id="edit-the-site">Edit the site</h3>
 <p>Using your favorite editors edit the site content, templates, and lib scripts.</p>
-<h3 id="python_markdown_daemon">Python Markdown Daemon</h3>
+<h3 id="python-markdown-daemon">Python Markdown Daemon</h3>
 <p>Start the Python Markdown daemon.</p>
 <div class="codehilite"><pre><span class="n">export</span> <span
class="n">MARKDOWN_SOCKET</span><span class="o">=</span><span class="sb">`pwd`</span><span
class="o">/</span><span class="n">markdown</span><span class="o">.</span><span
class="nb">socket</span> <span class="n">PYTHONPATH</span><span class="o">=</span><span
class="sb">`pwd`</span>
-<span class="n">python</span> <span class="n">markdownd</span><span
class="o">.</span><span class="n">py</span>
+<span class="n">python</span> <span class="n">cms</span><span
class="sr">/build/m</span><span class="n">arkdownd</span><span class="o">.</span><span
class="n">py</span>
 </pre></div>
 
 
-<h3 id="build_the_site">Build the site.</h3>
+<h3 id="build-the-site">Build the site.</h3>
 <div class="codehilite"><pre><span class="n">cms</span><span class="sr">/build/</span><span
class="n">build_site</span><span class="o">.</span><span class="n">pl</span>
<span class="o">--</span><span class="n">source</span><span class="o">-</span><span
class="n">base</span> <span class="n">site</span> <span class="o">--</span><span
class="n">target</span><span class="o">-</span><span class="n">base</span>
<span class="n">www</span>
 </pre></div>
 
 
-<h3 id="copy_the_site_to_your_computers_web_server">Copy the site to your computer's
web server.</h3>
+<h3 id="copy-the-site-to-your-computers-web-server">Copy the site to your computer's
web server.</h3>
 <p>On my Mac:</p>
 <div class="codehilite"><pre><span class="n">sudo</span> <span
class="n">scp</span> <span class="o">-</span><span class="n">rp</span>
<span class="n">www</span><span class="sr">/content/o</span><span
class="n">dftoolkit</span> <span class="sr">/Library/</span><span
class="n">WebServer</span><span class="sr">/Documents/</span><span
class="o">.</span>
 </pre></div>
 
 
 <p>The site is then available with <a href="http://localhost/odftoolkit">http://localhost/odftoolkit/</a>.</p>
-<h2 id="submitting_your_results">Submitting your results.</h2>
+<p>Or serve the site directly using the Python SimpleHTTPServer:</p>
+<div class="codehilite"><pre><span class="p">(</span><span class="n">cd</span>
<span class="n">www</span><span class="sr">/content/</span> <span
class="o">&amp;&amp;</span> <span class="n">python</span> <span
class="o">-</span><span class="n">m</span> <span class="n">SimpleHTTPServer</span>
<span class="mi">8080</span><span class="p">)</span>
+</pre></div>
+
+
+<p>The site is then available with <a href="http://localhost:8080/odftoolkit/">http://localhost:8080/odftoolkit/</a>.</p>
+<h2 id="submitting-your-results">Submitting your results.</h2>
 <h3 id="committer">Committer</h3>
 <p>Do the appropriate combination of svn status, svn add, and svn commits. Commits
will cause staging rebuilds.
 See <a href="docs/edit-cms.html">How to Edit the ODF Toolkit Website</a></p>



Mime
View raw message