Author: kschenk
Date: Sun Jun 22 22:13:54 2014
New Revision: 1604660
URL: http://svn.apache.org/r1604660
Log:
A few changes to explain things a little better.
Modified:
openoffice/site/trunk/content/website-local.mdtext
Modified: openoffice/site/trunk/content/website-local.mdtext
URL:
http://svn.apache.org/viewvc/openoffice/site/trunk/content/website-local.mdtext?rev=1604660&r1=1604659&r2=1604660&view=diff
==============================================================================
--- openoffice/site/trunk/content/website-local.mdtext (original)
+++ openoffice/site/trunk/content/website-local.mdtext Sun Jun 22 22:13:54 2014
@@ -82,7 +82,7 @@ after reviewing it in staging from a "co
* Or, you can use the command line, **publish.pl "site-name"**. For our
purposes,
**"site-name"** will either be **"openofficeorg"** or **"ooo-site"**.
-Generally speaking, unless you have established a full **Complete Local
Development** environment as described in the next
+Generally speaking, unless you have established a full **Complete Local
Website Development** environment as described in the next
section, you will likely be running **publish.pl** from your
"people.apache.org" account.
### For Contributors -- non-committers
@@ -91,9 +91,11 @@ to follow the procedures for "contributo
[Developer
FAQ](http://openoffice.apache.org/developer-faqs.html#im_not_a_committer)
for getting your changes published by a committer of the project, after you
submit a patch.
-## How To Do Website Development Locally (for technical users)
+## Complete Local Website Development (for technical users and committers)
+
+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.
-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.
@@ -111,7 +113,7 @@ site and the migrating openoffice.org we
mkdir aoo-web
cd aoo-web
-#### Download the svn repos for the AOO site.
+#### Download the svn repos for the AOO project site.
svn co https://svn.apache.org/repos/asf/openoffice/site/trunk site
@@ -123,7 +125,11 @@ site and the migrating openoffice.org we
svn co https://svn.apache.org/repos/infra/websites/cms/ cms
-You will have three sub-directories in your local website directory - `site`,
`ooo-site`, and `cms`.
+You will have three sub-directories in your local website directory -- `site`,
`ooo-site`, and `cms`.
+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:
+[http://www.apache.org/dev/cms.html](http://www.apache.org/dev/cms.html) for
more information on the
+ASF CMS directory structure.
#### Install Python dependencies.
@@ -158,6 +164,8 @@ The `site/templates` and `ooo-site/templ
* `html_page.html` - wrapping for html pages.
* `single_narrative.html` - extends skeleton.html.
+You may see other template files here as well that are used by Django during
the site construction.
+
#### Lib directory
The `site/lib` and `ooo-site/lib` directories contain two perl modules that
determine how content files are processed during the site build.
@@ -175,6 +183,8 @@ You can find the CMS build tools in the
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.
+This area should be updated, via svn update, as changes do take place on these
routines.
+
### Local Development
#### Edit the site
@@ -190,10 +200,15 @@ Start the Python Markdown daemon.
#### Build the sites.
+Using the directory names from Download sections above --
+
cms/build/build_site.pl --source-base site --target-base www
cms/build/build_site.pl --source-base ooo-site --target-base www
+
+This will generate the web content for the project site, "site", or the
openoffice site, "ooo-site"
+to directory "www".
-#### Copy the site to your computer's web server.
+#### Copy the site to an area your computer's web server.
On my Mac:
@@ -201,6 +216,7 @@ On my Mac:
The site is then available with [http://localhost/openofficeorg/][5] or
[http://localhost/][8]
+
### Submitting your results.
#### Committer
