incubator-odf-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From build...@apache.org
Subject svn commit: r794776 [3/3] - in /websites/staging/odftoolkit/trunk/content: ./ odftoolkit/ odftoolkit/docs/ odftoolkit/docs/governance/ odftoolkit/images/
Date Wed, 24 Aug 2011 01:45:45 GMT
Added: websites/staging/odftoolkit/trunk/content/odftoolkit/website-local.html
==============================================================================
--- websites/staging/odftoolkit/trunk/content/odftoolkit/website-local.html (added)
+++ websites/staging/odftoolkit/trunk/content/odftoolkit/website-local.html Wed Aug 24 01:45:44
2011
@@ -0,0 +1,192 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+<!--
+
+    Licensed to the Apache Software Foundation (ASF) under one or more
+    contributor license agreements.  See the NOTICE file distributed with
+    this work for additional information regarding copyright ownership.
+    The ASF licenses this file to You under the Apache License, Version 2.0
+    (the "License"); you may not use this file except in compliance with
+    the License.  You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE- 2.0
+
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+-->
+
+<link href="/odftoolkit/css/odf.css" rel="stylesheet" type="text/css">
+
+<title>Website Development</title>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+
+</head>
+
+<body>
+  <div id="banner">
+   <!-- <div id="bannerleft"><a alt="Apache ODF Toolkit (incubating)" href="http://incubator.apache.org/odftoolkit/">
+      <img id="logo" alt="Apache ODF Toolkit (Incubating)" src="/odftoolkit/images/ooo-logo.png"/></a></div>
-->
+    <div id="bannerright"><a alt="Apache Incubator" href="http://incubator.apache.org">
+      <img id="asf-logo" alt="Apache Incubator" src="/odftoolkit/images/apache-incubator-logo.png"/></a></div>
+   <div id="bannercenter"><br/>&nbsp;&nbsp;&nbsp;&nbsp;Apache
ODF Toolkit (incubating)</div>
+  </div>
+  
+  <div id="sidenav">
+    <h1 id="general">General</h1>
+<ul>
+<li><a href="/odftoolkit/index.html">About</a></li>
+<li><a href="http://incubator.apache.org/projects/odftoolkit.html">Incubator
page</a></li>
+<li><a href="/odftoolkit/license.html">License</a></li>
+</ul>
+<h1 id="community">Community</h1>
+<ul>
+<li><a href="/odftoolkit/get-involved.html">Get Involved</a></li>
+<li><a href="/odftoolkit/mailing-lists.html">Mailing Lists</a></li>
+<li><a href="/odftoolkit/people.html">People</a></li>
+<li><a href="/odftoolkit/community-faqs.html">Community FAQs</a></li>
+</ul>
+<h1 id="development">Development</h1>
+<ul>
+<li><a href="/odftoolkit/source.html">Source Code</a></li>
+<li><a href="/odftoolkit/website-local.html">Website</a></li>
+<li><a href="/odftoolkit/developer-faqs.html">Developer FAQs</a></li>
+</ul>
+<h1 id="ppmc">PPMC</h1>
+<ul>
+<li><a href="/odftoolkit/ppmc-faqs.html">PPMC FAQs</a><br />
+</li>
+</ul>
+<h1 id="asf">ASF</h1>
+<ul>
+<li><a href="http://www.apache.org">Apache Software Foundation</a></li>
+<li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li>
+<li><a href="http://www.apache.org/foundation/sponsorship.html">Become a Sponsor</a></li>
+</ul>
+  </div>
+  <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/odf/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>
+<ul>
+<li><a href="#setup">Setup</a> - How to download the Odf 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">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>
+<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>
+<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>
+<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>
+<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>
+<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>
+<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>
+<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>
+<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>
+<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>
+<li><code>cms/conversion-utilities/</code> - scripts used by various projects
for conversion including <code>cwiki</code> conversion.</li>
+<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>
+<p>Using your favorite editors edit the site content, templates, and lib scripts.</p>
+<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>
+</pre></div>
+
+
+<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>
+<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>
+<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>
+<h3 id="contributor">Contributor</h3>
+<p>(Add instructions on creating patches.)</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>
+
+  <div id="footera">
+    <div id="poweredby">
+      <p><img src="/odftoolkit/images/feather-small.gif"/><br/>Powered
by the Apache CMS.</p>
+    </div>
+    <div id="copyrighta">
+      <p>
+	Apache "ODF Toolkit" is an effort undergoing incubation at The Apache Software Foundation
(ASF), sponsored by the Apache Incubator.
+	Incubation is required of all newly accepted projects until a further review indicates that
the infrastructure, communications, and
+	decision making process	have stabilized in a manner consistent with other successful ASF
projects. While incubation status is
+	not necessarily a reflection of the completeness or stability of the code, it does indicate
that the project has
+	yet to be fully endorsed by the ASF.</p>
+      <p>
+	Copyright &copy; 2011 The Apache Software Foundation Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache
License, Version 2.0</a>.
+	<a href="/openofficeorg/contact.html">Contact Us</a>
+	<br />Apache and the Apache feather logos are trademarks of The Apache Software Foundation.
+	<br />Other names appearing on the site may be trademarks of their respective owners.
+      </p>
+    </div>
+  </div>
+
+</body>
+</html>



Mime
View raw message