Author: buildbot
Date: Sun Jun 22 22:13:58 2014
New Revision: 913298
Log:
Staging update by buildbot for openoffice
Modified:
websites/staging/openoffice/trunk/content/ (props changed)
websites/staging/openoffice/trunk/content/website-local.html
Propchange: websites/staging/openoffice/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Sun Jun 22 22:13:58 2014
@@ -1 +1 @@
-1599118
+1604660
Modified: websites/staging/openoffice/trunk/content/website-local.html
==============================================================================
--- websites/staging/openoffice/trunk/content/website-local.html (original)
+++ websites/staging/openoffice/trunk/content/website-local.html Sun Jun 22
22:13:58 2014
@@ -115,10 +115,10 @@ pages are updated by the project communi
<li><a href="#for-contributors-non-committers">For Contributors --
non-committers</a></li>
</ul>
</li>
-<li><a href="#how-to-do-website-development-locally-for-technical-users">How
To Do Website Development Locally (for technical users)</a><ul>
+<li><a
href="#complete-local-website-development-for-technical-users-and-committers">Complete
Local Website Development (for technical users and committers)</a><ul>
<li><a href="#setup">Setup</a><ul>
<li><a
href="#create-a-directory-on-your-computer-for-the-apache-cms-work-with-both-the-projects">Create
a directory on your computer for the Apache CMS work with both the
project's</a></li>
-<li><a href="#download-the-svn-repos-for-the-aoo-site">Download the svn repos
for the AOO site.</a></li>
+<li><a href="#download-the-svn-repos-for-the-aoo-project-site">Download the
svn repos for the AOO project site.</a></li>
<li><a
href="#download-the-svn-repos-for-the-migrated-openofficeorg-website">Download
the svn repos for the migrated OpenOffice.org website.</a></li>
<li><a href="#download-the-svn-repos-for-the-apache-cms">Download the svn
repos for the Apache CMS.</a></li>
<li><a href="#install-python-dependencies">Install Python
dependencies.</a></li>
@@ -138,7 +138,7 @@ pages are updated by the project communi
<li><a href="#edit-the-site">Edit the site</a></li>
<li><a href="#python-markdown-daemon">Python Markdown Daemon</a></li>
<li><a href="#build-the-sites">Build the sites.</a></li>
-<li><a href="#copy-the-site-to-your-computers-web-server">Copy the site to
your computer's web server.</a></li>
+<li><a href="#copy-the-site-to-an-area-your-computers-web-server">Copy the
site to an area your computer's web server.</a></li>
</ul>
</li>
<li><a href="#submitting-your-results">Submitting your results.</a><ul>
@@ -198,16 +198,17 @@ after reviewing it in staging from a "co
<li>Or, you can use the command line, <strong>publish.pl "site-name"</strong>.
For our purposes,
<strong>"site-name"</strong> will either be <strong>"openofficeorg"</strong>
or <strong>"ooo-site"</strong>. </li>
</ul>
-<p>Generally speaking, unless you have established a full <strong>Complete
Local Development</strong> environment as described in the next
+<p>Generally speaking, unless you have established a full <strong>Complete
Local Website Development</strong> environment as described in the next
section, you will likely be running <strong>publish.pl</strong> from your
"people.apache.org" account.</p>
<h3 id="for-contributors-non-committers">For Contributors --
non-committers</h3>
<p>If you are not a committer, you will need
to follow the procedures for "contributors" in the
<a
href="http://openoffice.apache.org/developer-faqs.html#im_not_a_committer";>Developer
FAQ</a>
for getting your changes published by a committer of the project, after you
submit a patch.</p>
-<h2 id="how-to-do-website-development-locally-for-technical-users">How To Do
Website Development Locally (for technical users)</h2>
-<p>The following information provides instructions on doing website
development on your local computer.
-These instructions assume you have setup a webserver in your local
environment. Details are
+<h2
id="complete-local-website-development-for-technical-users-and-committers">Complete
Local Website Development (for technical users and committers)</h2>
+<p>The following information provides instructions on doing website
development for either of the OpenOffice websites
+on your local computer. If you feel a need to change anything on the websites
that effect site processing by the CMS -- e.g. the templates, processing for
new file types not included in /lib/path.pm, additional Django template
capabilities, etc. -- you will need to setup a local website development area
for testing changes.</p>
+<p>These instructions assume you have setup a webserver in your local
environment. Details are
provided on setting up the resources needed to process "Markdown" on your
local server
and how to publish to the production Apache OpenOffice sites from your local
environment. </p>
<ul>
@@ -224,7 +225,7 @@ and how to publish to the production Apa
</pre></div>
-<h4 id="download-the-svn-repos-for-the-aoo-site">Download the svn repos for
the AOO site.</h4>
+<h4 id="download-the-svn-repos-for-the-aoo-project-site">Download the svn
repos for the AOO project site.</h4>
<div class="codehilite"><pre><span class="n">svn</span> <span
class="n">co</span> <span class="n">https</span><span class="p">:</span><span
class="o">//</span><span class="n">svn</span><span class="p">.</span><span
class="n">apache</span><span class="p">.</span><span class="n">org</span><span
class="o">/</span><span class="n">repos</span><span class="o">/</span><span
class="n">asf</span><span class="o">/</span><span
class="n">openoffice</span><span class="o">/</span><span
class="n">site</span><span class="o">/</span><span class="n">trunk</span> <span
class="n">site</span>
</pre></div>
@@ -239,7 +240,11 @@ and how to publish to the production Apa
</pre></div>
-<p>You will have three sub-directories in your local website directory -
<code>site</code>, <code>ooo-site</code>, and <code>cms</code>.</p>
+<p>You will have three sub-directories in your local website directory --
<code>site</code>, <code>ooo-site</code>, and <code>cms</code>.
+The "cms" directory will contain scripts needed to build either of the
websites using the ASF CMS in a local environment. This is
+necessary to see how changes to templates or other ASF CMS internal files will
affect the website. See:
+<a
href="http://www.apache.org/dev/cms.html";>http://www.apache.org/dev/cms.html</a>
for more information on the
+ASF CMS directory structure.</p>
<h4 id="install-python-dependencies">Install Python dependencies.</h4>
<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>
@@ -267,6 +272,7 @@ and how to publish to the production Apa
<li><code>html_page.html</code> - wrapping for html pages.</li>
<li><code>single_narrative.html</code> - extends skeleton.html.</li>
</ul>
+<p>You may see other template files here as well that are used by Django
during the site construction.</p>
<h4 id="lib-directory">Lib directory</h4>
<p>The <code>site/lib</code> and <code>ooo-site/lib</code> directories contain
two perl modules that determine how content files are processed during the site
build.</p>
<ul>
@@ -281,6 +287,7 @@ and how to publish to the production Apa
<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>
+<p>This area should be updated, via svn update, as changes do take place on
these routines.</p>
<h3 id="local-development">Local Development</h3>
<h4 id="edit-the-site">Edit the site</h4>
<p>Using your favorite editors edit the site content, templates, and lib
scripts.</p>
@@ -292,12 +299,15 @@ and how to publish to the production Apa
<h4 id="build-the-sites">Build the sites.</h4>
+<p>Using the directory names from Download sections above --</p>
<div class="codehilite"><pre><span class="n">cms</span><span
class="o">/</span><span class="n">build</span><span class="o">/</span><span
class="n">build_site</span><span class="p">.</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>
<span class="n">cms</span><span class="o">/</span><span
class="n">build</span><span class="o">/</span><span
class="n">build_site</span><span class="p">.</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">ooo</span><span
class="o">-</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>
-<h4 id="copy-the-site-to-your-computers-web-server">Copy the site to your
computer's web server.</h4>
+<p>This will generate the web content for the project site, "site", or the
openoffice site, "ooo-site"
+to directory "www". </p>
+<h4 id="copy-the-site-to-an-area-your-computers-web-server">Copy the site to
an area your computer's web server.</h4>
<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="o">/</span><span class="n">content</span>
<span class="o">/</span><span class="n">Library</span><span
class="o">/</span><span class="n">WebServer</span><span class="o">/</span><span
class="n">Documents</span><span class="o">/</span><span class="p">.</span>
</pre></div>
