Author: buildbot Date: Mon Aug 3 23:18:05 2015 New Revision: 960695 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 Mon Aug 3 23:18:05 2015 @@ -1 +1 @@ -1693969 +1693982 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 Mon Aug 3 23:18:05 2015 @@ -49,7 +49,18 @@ <div id="clear"></div> <div id="sidenav"> - <h1 id="general">General</h1> + <style type="text/css"> +/* The following code is added by mdx_elementid.py + It was originally lifted from http://subversion.apache.org/style/site.css */ +/* + * Hide class="elementid-permalink", except when an enclosing heading + * has the :hover property. + */ +.headerlink, .elementid-permalink { + visibility: hidden; +} +h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style> +<h1 id="general">General<a class="headerlink" href="#general" title="Permanent link">¶</a></h1> <ul> <li><a href="/index.html">About</a></li> <li><a href="/downloads.html">Downloads</a></li> @@ -58,7 +69,7 @@ <li><a href="/press.html">Press</a></li> <li><a href="http://www.openoffice.org/">OpenOffice.org website</a></li> </ul> -<h1 id="community">Community</h1> +<h1 id="community">Community<a class="headerlink" href="#community" title="Permanent link">¶</a></h1> <ul> <li><a href="/get-involved.html">Get Involved</a></li> <li><a href="/orientation/index.html">Orientation</a></li> @@ -71,7 +82,7 @@ <li><a href="/people.html">People</a></li> <li><a href="/community-faqs.html">Community FAQs</a></li> </ul> -<h1 id="development">Development</h1> +<h1 id="development">Development<a class="headerlink" href="#development" title="Permanent link">¶</a></h1> <ul> <li><a href="/source.html">Source Code</a></li> <li><a href="/bug-tracking.html">Bug Tracking</a></li> @@ -82,12 +93,12 @@ <li><a href="/contributing-code.html">Contributing Code</a> </li> <li><a href="/developer-faqs.html">Developer FAQs</a></li> </ul> -<h1 id="project-management-pmc">Project Management PMC</h1> +<h1 id="project-management-pmc">Project Management PMC<a class="headerlink" href="#project-management-pmc" title="Permanent link">¶</a></h1> <ul> <li><a href="http://blogs.apache.org/OOo/">Project Blog</a></li> <li><a href="/pmc-faqs.html">PMC FAQs</a> </li> </ul> -<h1 id="the-apache-software-foundation">The Apache Software Foundation</h1> +<h1 id="the-apache-software-foundation">The Apache Software Foundation<a class="headerlink" href="#the-apache-software-foundation" title="Permanent link">¶</a></h1> <ul> <li><a href="http://www.apache.org/">Website</a></li> <li><a href="http://www.openoffice.org/donations.html">Donations</a></li> @@ -98,7 +109,18 @@ <div id="contenta"> <h1 class="title">Website Development</h1> - <p>Making updates to the Apache OpenOffice project's websites is simple. It's even easy + <style type="text/css"> +/* The following code is added by mdx_elementid.py + It was originally lifted from http://subversion.apache.org/style/site.css */ +/* + * Hide class="elementid-permalink", except when an enclosing heading + * has the :hover property. + */ +.headerlink, .elementid-permalink { + visibility: hidden; +} +h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style> +<p>Making updates to the Apache OpenOffice project's websites is simple. It's even easy for non-committers (new contributors - like you) to create a patch to request that pages are updated by the project community.</p> <div class="toc"> @@ -123,7 +145,7 @@ pages are updated by the project communi <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> -<li><a href="#check-your-version-of-python">Check your version of Python</a></li> +<li><a href="#check-that-your-version-of-python-is-27-or-greater">Check that your version of Python is 2.7 or greater</a></li> <li><a href="#follow-the-installation-instructions-for-setuptools">Follow the installation instructions for setuptools.</a></li> <li><a href="#install-dependencies">Install dependencies</a></li> </ul> @@ -152,7 +174,7 @@ pages are updated by the project communi <li><a href="#google-analytics">Google Analytics</a></li> </ul> </div> -<h2 id="two-websites">Two Websites</h2> +<h2 id="two-websites">Two Websites<a class="headerlink" href="#two-websites" title="Permanent link">¶</a></h2> <p>The Apache OpenOffice project maintains two websites:</p> <ul> <li>The <a href="http://openoffice.apache.org/">project website</a>, primarily for development and technical information (which you're viewing now). @@ -168,11 +190,11 @@ the staging sites for these areas, respe <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> -<h2 id="version-control">Version Control</h2> +<h2 id="version-control">Version Control<a class="headerlink" href="#version-control" title="Permanent link">¶</a></h2> <p>We use <a href="http://subversion.apache.org">Apache Subversion</a> for version control. You can <a href="https://svn.apache.org/repos/asf/openoffice/site/trunk/">browse the project repository</a> or <a href="https://svn.apache.org/repos/asf/openoffice/ooo-site/trunk/">browse the user portal repository</a> source files directly in your web browser.</p> -<h2 id="how-to-make-or-request-changes-to-the-websites">How To Make or Request Changes to the Websites</h2> -<h3 id="using-svn-directly-for-technical-users">Using SVN Directly (for technical users)</h3> +<h2 id="how-to-make-or-request-changes-to-the-websites">How To Make or Request Changes to the Websites<a class="headerlink" href="#how-to-make-or-request-changes-to-the-websites" title="Permanent link">¶</a></h2> +<h3 id="using-svn-directly-for-technical-users">Using SVN Directly (for technical users)<a class="headerlink" href="#using-svn-directly-for-technical-users" title="Permanent link">¶</a></h3> <p>You can make changes to either site using svn (subversion). This typically involves doing an svn checkout, making changes to files and --</p> <ul> @@ -195,16 +217,16 @@ issue number so we can follow-up.</p> </li> </ul> <p>Changes committed with SVN commit your changes to the "staging area". These changes will need to be published to become active on the "production" site.</p> -<h3 id="using-the-apache-cms-bookmarklet-simpler-method">Using the Apache CMS Bookmarklet (simpler method)</h3> +<h3 id="using-the-apache-cms-bookmarklet-simpler-method">Using the Apache CMS Bookmarklet (simpler method)<a class="headerlink" href="#using-the-apache-cms-bookmarklet-simpler-method" title="Permanent link">¶</a></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 committer and use the bookmarklet in your web browser, you should use your Apache credentials to log in, make changes and submit them to staging. If you are not a committer, you can still use the bookmarklet by signing in to the bookmarklet as <em>anonymous</em>. See detailed how-to steps in the <a href="http://www.apache.org/dev/cmsref.html#non-committer">Apache CMS Reference</a> for non-committers.</p> -<h3 id="more-details">More Details</h3> +<h3 id="more-details">More Details<a class="headerlink" href="#more-details" title="Permanent link">¶</a></h3> <p>Additional details on the above methods can be found on <a href="http://openoffice.apache.org/docs/edit-cms.html">How to edit the Apache OpenOffice website</a>.</p> -<h2 id="publishing-changes-to-the-production-websites">Publishing Changes to the Production Websites</h2> -<h3 id="for-committers">For Committers</h3> +<h2 id="publishing-changes-to-the-production-websites">Publishing Changes to the Production Websites<a class="headerlink" href="#publishing-changes-to-the-production-websites" title="Permanent link">¶</a></h2> +<h3 id="for-committers">For Committers<a class="headerlink" href="#for-committers" title="Permanent link">¶</a></h3> <p>As previously noted, changes you make, either through an svn commit or using the CMS GUI tool, are enacted on the staging sites. Once you review your changes on the staging site, you can "publish" the site -- enacting our changes on the production site. Only Apache "committers" can actually publish sites. </p> @@ -218,12 +240,12 @@ after reviewing it in staging from a "co </ul> <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> +<h3 id="for-contributors-non-committers">For Contributors -- non-committers<a class="headerlink" href="#for-contributors-non-committers" title="Permanent link">¶</a></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="complete-local-website-development-for-technical-users-and-committers">Complete Local Website Development (for technical users and committers)</h2> +<h2 id="complete-local-website-development-for-technical-users-and-committers">Complete Local Website Development (for technical users and committers)<a class="headerlink" href="#complete-local-website-development-for-technical-users-and-committers" title="Permanent link">¶</a></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 @@ -235,25 +257,25 @@ and how to publish to the production Apa <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> -<h3 id="setup">Setup</h3> -<h4 id="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</h4> +<h3 id="setup">Setup<a class="headerlink" href="#setup" title="Permanent link">¶</a></h3> +<h4 id="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 class="headerlink" href="#create-a-directory-on-your-computer-for-the-apache-cms-work-with-both-the-projects" title="Permanent link">¶</a></h4> <p>site and the migrating openoffice.org website.</p> <div class="codehilite"><pre><span class="n">mkdir</span> <span class="n">aoo</span><span class="o">-</span><span class="n">web</span> <span class="n">cd</span> <span class="n">aoo</span><span class="o">-</span><span class="n">web</span> </pre></div> -<h4 id="download-the-svn-repos-for-the-aoo-project-site">Download the svn repos for the AOO project site.</h4> +<h4 id="download-the-svn-repos-for-the-aoo-project-site">Download the svn repos for the AOO project site.<a class="headerlink" href="#download-the-svn-repos-for-the-aoo-project-site" title="Permanent link">¶</a></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> -<h4 id="download-the-svn-repos-for-the-migrated-openofficeorg-website">Download the svn repos for the migrated OpenOffice.org website.</h4> +<h4 id="download-the-svn-repos-for-the-migrated-openofficeorg-website">Download the svn repos for the migrated OpenOffice.org website.<a class="headerlink" href="#download-the-svn-repos-for-the-migrated-openofficeorg-website" title="Permanent link">¶</a></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">ooo</span><span class="o">-</span><span class="n">site</span><span class="o">/</span><span class="n">trunk</span> <span class="n">ooo</span><span class="o">-</span><span class="n">site</span> </pre></div> -<h4 id="download-the-svn-repos-for-the-apache-cms">Download the svn repos for the Apache CMS.</h4> +<h4 id="download-the-svn-repos-for-the-apache-cms">Download the svn repos for the Apache CMS.<a class="headerlink" href="#download-the-svn-repos-for-the-apache-cms" title="Permanent link">¶</a></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">infra</span><span class="o">/</span><span class="n">websites</span><span class="o">/</span><span class="n">cms</span><span class="o">/</span> <span class="n">cms</span> </pre></div> @@ -263,26 +285,26 @@ The "cms" directory will contain scripts 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> +<h4 id="install-python-dependencies">Install Python dependencies.<a class="headerlink" href="#install-python-dependencies" title="Permanent link">¶</a></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> +<h4 id="check-that-your-version-of-python-is-27-or-greater">Check that your version of Python is 2.7 or greater<a class="headerlink" href="#check-that-your-version-of-python-is-27-or-greater" title="Permanent link">¶</a></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-setuptools">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>.<a class="headerlink" href="#follow-the-installation-instructions-for-setuptools" title="Permanent link">¶</a></h4> +<h4 id="install-dependencies">Install dependencies<a class="headerlink" href="#install-dependencies" title="Permanent link">¶</a></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> -<h3 id="directory-layout">Directory Layout</h3> -<h4 id="content-directories">Content directories</h4> +<h3 id="directory-layout">Directory Layout<a class="headerlink" href="#directory-layout" title="Permanent link">¶</a></h3> +<h4 id="content-directories">Content directories<a class="headerlink" href="#content-directories" title="Permanent link">¶</a></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> +<h4 id="templates-directory">Templates directory<a class="headerlink" href="#templates-directory" title="Permanent link">¶</a></h4> <p>The <code>site/templates</code> and <code>ooo-site/templates</code> directories contain the html skeletons used during the site build.</p> <ul> <li><code>skeleton.html</code> - our current html page template.</li> @@ -291,13 +313,13 @@ ASF CMS directory structure.</p> <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> +<h4 id="lib-directory">Lib directory<a class="headerlink" href="#lib-directory" title="Permanent link">¶</a></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> <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<a class="headerlink" href="#build-tools" title="Permanent link">¶</a></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> @@ -306,17 +328,17 @@ ASF CMS directory structure.</p> </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> +<h3 id="local-development">Local Development<a class="headerlink" href="#local-development" title="Permanent link">¶</a></h3> +<h4 id="edit-the-site">Edit the site<a class="headerlink" href="#edit-the-site" title="Permanent link">¶</a></h4> <p>Using your favorite editors edit the site content, templates, and lib scripts.</p> -<h4 id="python-markdown-daemon">Python Markdown Daemon</h4> +<h4 id="python-markdown-daemon">Python Markdown Daemon<a class="headerlink" href="#python-markdown-daemon" title="Permanent link">¶</a></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="p">=</span>`<span class="n">pwd</span>`<span class="o">/</span><span class="n">markdown</span><span class="p">.</span><span class="n">socket</span> <span class="n">PYTHONPATH</span><span class="p">=</span>`<span class="n">pwd</span>` <span class="n">python</span> <span class="n">cms</span><span class="o">/</span><span class="n">build</span><span class="o">/</span><span class="n">markdownd</span><span class="p">.</span><span class="n">py</span> </pre></div> -<h4 id="build-the-sites">Build the sites.</h4> +<h4 id="build-the-sites">Build the sites.<a class="headerlink" href="#build-the-sites" title="Permanent link">¶</a></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> @@ -325,25 +347,25 @@ ASF CMS directory structure.</p> <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> +<h4 id="copy-the-site-to-an-area-your-computers-web-server">Copy the site to an area your computer's web server.<a class="headerlink" href="#copy-the-site-to-an-area-your-computers-web-server" title="Permanent link">¶</a></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> <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> -<h3 id="submitting-your-results">Submitting your results.</h3> -<h4 id="committer">Committer</h4> +<h3 id="submitting-your-results">Submitting your results.<a class="headerlink" href="#submitting-your-results" title="Permanent link">¶</a></h3> +<h4 id="committer">Committer<a class="headerlink" href="#committer" title="Permanent link">¶</a></h4> <p>Do the appropriate combination of svn status, svn add, and svn commits. Commits will cause staging rebuilds. See <a href="https://cms.apache.org/#bookmark">How to Edit the Apache OpenOffice 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> -<h4 id="contributor">Contributor</h4> +<h4 id="contributor">Contributor<a class="headerlink" href="#contributor" title="Permanent link">¶</a></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> -<h2 id="google-analytics">Google Analytics</h2> +<h2 id="google-analytics">Google Analytics<a class="headerlink" href="#google-analytics" title="Permanent link">¶</a></h2> <p>We use Google Analytics on key webpages to gather information on website usage patterns. This information is then used to help us prioritize what areas of the website should get more attention.</p>