You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@openoffice.apache.org by ks...@apache.org on 2012/01/31 00:49:04 UTC
svn commit: r803604 - in /websites/production/openofficeorg: ./
content/openofficeorg/website-local.html
Author: kschenk
Date: Mon Jan 30 23:49:04 2012
New Revision: 803604
Log:
kls -- ok, done!
Modified:
websites/production/openofficeorg/ (props changed)
websites/production/openofficeorg/content/openofficeorg/website-local.html
Propchange: websites/production/openofficeorg/
------------------------------------------------------------------------------
--- svn:mergeinfo (original)
+++ svn:mergeinfo Mon Jan 30 23:49:04 2012
@@ -1 +1 @@
-/websites/staging/openofficeorg/trunk:791146-802935
+/websites/staging/openofficeorg/trunk:791146-803603
Modified: websites/production/openofficeorg/content/openofficeorg/website-local.html
==============================================================================
--- websites/production/openofficeorg/content/openofficeorg/website-local.html (original)
+++ websites/production/openofficeorg/content/openofficeorg/website-local.html Mon Jan 30 23:49:04 2012
@@ -78,42 +78,89 @@
<div id="contenta">
<h1 class="title">Website Development</h1>
- <p>We use <a href="http://subversion.apache.org">Apache Subversion</a> for version control. You can <a href="http://svn.apache.org/viewvc/incubator/ooo/site/trunk">browse our
-repository</a> in your web browser.</p>
-<p>Quick editing of the site is available for committers using the Apache CMS
-<a href="docs/edit-cms.html">from your browser.</a></p>
-<p>This page gives instructions on doing website development on your local computer.</p>
+ <h2 id="two_websites">Two Websites</h2>
+<p>The Apache OpenOffice project maintains two websites:</p>
+<ul>
+<li>The <a href="http://incubator.apache.org/openofficeorg/">project website</a> (from which you are viewing this page)</li>
+<li>The user portal, <a href="http://www.openoffice.org">www.openoffice.org</a></li>
+</ul>
+<p>Both of these sites use the <a href="http://www.apache.org/dev/cms.html">Apache Content Management System</a> (CMS).
+In essence, regardless of how you make changes to either web area, the changes first go
+the staging sites for these areas, respectively --</p>
+<ul>
+<li>The <a href="http://openofficeorg.staging.apache.org/">project staging site</a></li>
+<li>The <a href="http://ooo-site.staging.apache.org/">user portal staging site</a></li>
+</ul>
+<p>Additionally, the project website uses <a href="http://daringfireball.net/projects/markdown/">Markdown</a> for page contents.
+The "legacy" OpenOffice.org site uses html.</p>
+<h2 id="version_control">Version Control</h2>
+<p>We use <a href="http://subversion.apache.org">Apache Subversion</a> for version control. You can <a href="http://svn.apache.org/viewvc/incubator/ooo/site/trunk">browse the project
+repository</a> or <a href="https://svn.apache.org/repos/asf/incubator/ooo/ooo-site/trunk/">browse the user portal</a> in your web browser.</p>
+<h2 id="making_changes_to_the_sites">Making Changes to the Sites</h2>
+<h3 id="using_svn">Using SVN</h3>
+<p>You can make changes to either site using svn (subversion). This typically involves
+doing an svn checkout, making changes to files and then either committing your changes
+if you are an "Apache committer", or submitting a "patch" (an svn "diff" file) if you are a contributor but
+not a "committer". Consult your local svn implementation for how to do commits or create
+patches. (See also, the <a href="http://svnbook.red-bean.com/">SVN Book</a> ). Patches can be submitted as attachments to e-mail to the
+<a href="mailto:ooo-dev@incubator.apache.org">Apache OpenOffice developer</a> list.</p>
+<p>SVN commits will commit your changes to the "staging area". you will need to
+"publish" your changes to make them active on the "production" site.</p>
+<h3 id="using_the_apache_cms_bookmarklet">Using the Apache CMS Bookmarklet</h3>
+<p>Quick editing of the site is available for committers and contributors using the Apache CMS
+<a href="https://cms.apache.org/#bookmark">from your browser.</a> If you are a commtter and use the bookmarklet, you should use
+your Apache credentials to log in, make changes and submit them to staging.
+If you are a contributor, and not a committer, you can still use the bookmarklet.
+See additional details in the <a href="http://www.apache.org/dev/cmsref.html#non-committer">Apache CMS Reference</a>.</p>
+<h2 id="publishing_changes">Publishing Changes</h2>
+<p>As previously noted, changes you make, either through and svn commit or using the CMS GUI tool,
+are enacted on the staging sites. Only Apache "committers" can actually publish sites. </p>
+<ul>
+<li>You can use the CMS GUI tool to also commit, review, and publish your changes from the
+staging site. </li>
+<li>Or, you can use the "publish" link for a site from the <a href="https://cms.apache.org/">CMS Web Site</a>
+after reviewing it in staging from a "commit" operations.</li>
+<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
+section, you will likely be running <strong>publish.pl</strong> from your "people.apache.org" account.</p>
+<h2 id="preparations_for_complete_local_development">Preparations for Complete Local Development</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
+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>
<li><a href="#setup">Setup</a> - How to download the OOo project site repos and setup the Apache CMS.</li>
<li><a href="#directory_layout">Directory Layout</a> - Where to find the content, templates, and scripts.</li>
<li><a href="#local_development">Local Development</a> - How to build and test locally.</li>
<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_for_the_apache_cms_work_with_both_the_podlings">Create a directory on your computer for the Apache CMS work with both the podling's</h3>
+<h3 id="setup">Setup</h3>
+<h4 id="create_a_directory_on_your_computer_for_the_apache_cms_work_with_both_the_podlings">Create a directory on your computer for the Apache CMS work with both the podling's</h4>
<p>incubator site and the migrating openoffice.org website.</p>
<div class="codehilite"><pre><span class="nb">mkdir</span> <span class="n">ooo</span><span class="o">-</span><span class="n">web</span>
<span class="n">cd</span> <span class="n">ooo</span><span class="o">-</span><span class="n">web</span>
</pre></div>
-<h3 id="download_the_svn_repos_for_the_aooo_site">Download the svn repos for the AOOo site.</h3>
+<h4 id="download_the_svn_repos_for_the_aooo_site">Download the svn repos for the AOOo site.</h4>
<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/ooo/site/</span><span class="n">trunk</span> <span class="n">site</span>
</pre></div>
-<h3 id="download_the_svn_repos_for_the_openofficeorg_migration_website">Download the svn repos for the OpenOffice.org migration website.</h3>
+<h4 id="download_the_svn_repos_for_the_migrated_openofficeorg_website">Download the svn repos for the migrated OpenOffice.org website.</h4>
<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/ooo/ooo-site/</span><span class="n">trunk</span> <span class="n">ooo</span><span class="o">-</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>
+<h4 id="download_the_svn_repos_for_the_apache_cms">Download the svn repos for the Apache CMS.</h4>
<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>
<p>You will have three sub-directories in your local website directory - <code>site</code>, <code>ooo-site</code>, and <code>cms</code>.</p>
-<h3 id="install_python_dependencies">Install Python dependencies.</h3>
+<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>
<h4 id="check_your_version_of_python">Check your version of Python</h4>
@@ -129,7 +176,7 @@ repository</a> in your web browser.</p>
</pre></div>
-<h2 id="directory_layout">Directory Layout</h2>
+<h3 id="directory_layout">Directory Layout</h3>
<h4 id="content_directories">Content directories</h4>
<p>The <code>site/content/openofficeorg</code> and <code>ooo-site/content/</code> directories contain web content - markdown, html, javascript, css, images and other files. Files that do not fit recognized patterns from <code>site/lib/path.pm</code> or <code>ooo-site/lib/path.pm</code> are copied as is to the web site during the build.</p>
<h4 id="templates_directory">Templates directory</h4>
@@ -154,39 +201,39 @@ 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>
+<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>
-<h3 id="python_markdown_daemon">Python Markdown Daemon</h3>
+<h4 id="python_markdown_daemon">Python Markdown Daemon</h4>
<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">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_sites">Build the sites.</h3>
+<h4 id="build_the_sites">Build the sites.</h4>
<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>
<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">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>
-<h3 id="copy_the_site_to_your_computers_web_server">Copy the site to your computer's web server.</h3>
+<h4 id="copy_the_site_to_your_computers_web_server">Copy the site to 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="sr">/content /</span><span class="n">Library</span><span class="sr">/WebServer/</span><span class="n">Documents</span><span class="o">/.</span>
</pre></div>
<p>The site is then available with <a href="http://localhost/openofficeorg">http://localhost/openofficeorg/</a> or <a href="http://localhost/">http://localhost/</a></p>
-<h2 id="submitting_your_results">Submitting your results.</h2>
-<h3 id="committer">Committer</h3>
+<h3 id="submitting_your_results">Submitting your results.</h3>
+<h4 id="committer">Committer</h4>
<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 OpenOffice.org Website</a></p>
+See <a href="https://cms.apache.org/#bookmark">How to Edit the OpenOffice.org Website</a></p>
<p>Please note that if you have removed any files or directories from your source tree then you must also remove
these from the staging build. The staging for the project site is
<code>https://svn.apache.org/repos/infra/websites/staging/openofficeorg</code>. Check the staging builf out,
svn remove and commit the same files and directories.</p>
-<h3 id="contributor">Contributor</h3>
-<p>(Add instructions on creating patches.)</p>
+<h4 id="contributor">Contributor</h4>
+<p>Use SVN to submit svn "diffs".</p>
<p>For further information see the <a href="http://www.apache.org/dev/version-control.html">Apache Source Code Repository</a> page.</p>
</div>