Author: kschenk
Date: Mon Jan 30 23:47:34 2012
New Revision: 1238091
URL: http://svn.apache.org/viewvc?rev=1238091&view=rev
Log:
kls -- lots of changes
Modified:
incubator/ooo/site/trunk/content/openofficeorg/website-local.mdtext
Modified: incubator/ooo/site/trunk/content/openofficeorg/website-local.mdtext
URL:
http://svn.apache.org/viewvc/incubator/ooo/site/trunk/content/openofficeorg/website-local.mdtext?rev=1238091&r1=1238090&r2=1238091&view=diff
==============================================================================
--- incubator/ooo/site/trunk/content/openofficeorg/website-local.mdtext
(original)
+++ incubator/ooo/site/trunk/content/openofficeorg/website-local.mdtext Mon Jan
30 23:47:34 2012
@@ -16,42 +16,99 @@ Notice: Licensed to the Apache Softwa
specific language governing permissions and limitations
under the License.
-We use [Apache Subversion][1] for version control. You can [browse our
-repository][2] in your web browser.
+## Two Websites
-Quick editing of the site is available for committers using the Apache CMS
-[from your browser.][6]
+The Apache OpenOffice project maintains two websites:
-This page gives instructions on doing website development on your local
computer.
+* The [project website](http://incubator.apache.org/openofficeorg/) (from
which you are viewing this page)
+* The user portal, [www.openoffice.org](http://www.openoffice.org)
+
+Both of these sites use the [Apache Content Management
System](http://www.apache.org/dev/cms.html) (CMS).
+In essence, regardless of how you make changes to either web area, the changes
first go
+the staging sites for these areas, respectively --
+
+* The [project staging site](http://openofficeorg.staging.apache.org/)
+* The [user portal staging site](http://ooo-site.staging.apache.org/)
+
+Additionally, the project website uses
[Markdown](http://daringfireball.net/projects/markdown/) for page contents.
+The "legacy" OpenOffice.org site uses html.
+
+## Version Control
+
+We use [Apache Subversion][1] for version control. You can [browse the project
+repository][2] or [browse the user portal][9] in your web browser.
+
+## Making Changes to the Sites
+
+### Using SVN
+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 [SVN Book](http://svnbook.red-bean.com/) ). Patches
can be submitted as attachments to e-mail to the
+[Apache OpenOffice developer](mailto:[email protected]) list.
+
+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.
+
+### Using the Apache CMS Bookmarklet
+
+Quick editing of the site is available for committers and contributors using
the Apache CMS
+[from your browser.][6] 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 [Apache CMS
Reference](http://www.apache.org/dev/cmsref.html#non-committer).
+
+## Publishing Changes
+
+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.
+
+* You can use the CMS GUI tool to also commit, review, and publish your
changes from the
+staging site.
+* Or, you can use the "publish" link for a site from the [CMS Web
Site](https://cms.apache.org/)
+after reviewing it in staging from a "commit" operations.
+* 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
+section, you will likely be running **publish.pl** from your
"people.apache.org" account.
+
+## Preparations for Complete Local Development
+
+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.
* [Setup](#setup) - How to download the OOo project site repos and setup the
Apache CMS.
* [Directory Layout](#directory_layout) - Where to find the content,
templates, and scripts.
* [Local Development](#local_development) - How to build and test locally.
* [Submitting Your Results](#submitting_your_results) - How to contribute your
edits.
-## Setup
+### Setup
-### Create a directory on your computer for the Apache CMS work with both the
podling's
+#### Create a directory on your computer for the Apache CMS work with both the
podling's
incubator site and the migrating openoffice.org website.
mkdir ooo-web
cd ooo-web
-### Download the svn repos for the AOOo site.
+#### Download the svn repos for the AOOo site.
svn co https://svn.apache.org/repos/asf/incubator/ooo/site/trunk site
-### Download the svn repos for the OpenOffice.org migration website.
+#### Download the svn repos for the migrated OpenOffice.org website.
svn co https://svn.apache.org/repos/asf/incubator/ooo/ooo-site/trunk
ooo-site
-### Download the svn repos for the Apache CMS.
+#### Download the svn repos for the Apache CMS.
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`.
-### Install Python dependencies.
+#### Install Python dependencies.
Adapted from the [Apache CMS Reference][3]
@@ -69,7 +126,7 @@ The easiest way to install the dependenc
sudo easy_install ElementTree
sudo easy_install Markdown
-## Directory Layout
+### Directory Layout
#### Content directories
@@ -101,25 +158,25 @@ 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.
-## Local Development
+### Local Development
-### Edit the site
+#### Edit the site
Using your favorite editors edit the site content, templates, and lib scripts.
-### Python Markdown Daemon
+#### Python Markdown Daemon
Start the Python Markdown daemon.
export MARKDOWN_SOCKET=`pwd`/markdown.socket PYTHONPATH=`pwd`
python cms/build/markdownd.py
-### Build the sites.
+#### Build the sites.
cms/build/build_site.pl --source-base site --target-base www
cms/build/build_site.pl --source-base ooo-site --target-base www
-### Copy the site to your computer's web server.
+#### Copy the site to your computer's web server.
On my Mac:
@@ -127,9 +184,9 @@ On my Mac:
The site is then available with [http://localhost/openofficeorg/][5] or
[http://localhost/][8]
-## Submitting your results.
+### Submitting your results.
-### Committer
+#### Committer
Do the appropriate combination of svn status, svn add, and svn commits.
Commits will cause staging rebuilds.
See [How to Edit the OpenOffice.org Website][6]
@@ -139,9 +196,9 @@ these from the staging build. The stagin
`https://svn.apache.org/repos/infra/websites/staging/openofficeorg`. Check the
staging builf out,
svn remove and commit the same files and directories.
-### Contributor
+#### Contributor
-(Add instructions on creating patches.)
+Use SVN to submit svn "diffs".
For further information see the [Apache Source Code Repository][7] page.
@@ -150,6 +207,7 @@ For further information see the [Apache
[3]: http://www.apache.org/dev/cmsref.html#local-build
[4]: http://pypi.python.org/pypi/setuptools
[5]: http://localhost/openofficeorg
-[6]: docs/edit-cms.html
+[6]: https://cms.apache.org/#bookmark
[7]: http://www.apache.org/dev/version-control.html
-[8]: http://localhost/
\ No newline at end of file
+[8]: http://localhost/
+[9]: https://svn.apache.org/repos/asf/incubator/ooo/ooo-site/trunk/
\ No newline at end of file
