Author: mikedd
Date: Wed Nov 14 03:08:59 2012
New Revision: 1409069
URL: http://svn.apache.org/viewvc?rev=1409069&view=rev
Log:
Add instructions for running the build tool
Added:
openjpa/site/trunk/instructions.mdtext
Added: openjpa/site/trunk/instructions.mdtext
URL:
http://svn.apache.org/viewvc/openjpa/site/trunk/instructions.mdtext?rev=1409069&view=auto
==============================================================================
--- openjpa/site/trunk/instructions.mdtext (added)
+++ openjpa/site/trunk/instructions.mdtext Wed Nov 14 03:08:59 2012
@@ -0,0 +1,47 @@
+# Installing the build tools
+
+1. Get the cms build tools from the infrastructure SVN repository. These
scripts will generate HTML from markdown files (among other things).
+ svn co http://svn.apache.org/repos/infra/websites/cms/build ~/cms/build
+
+2. Read the instructions at http://www.apache.org/dev/cmsref.html#local-build
+
+3. No, seriously, read the instructions.
+
+4. OK here's my version :
+ * The tools work on Ubuntu (and presumably any debian system). They should
also work on Windows, but after some initial headaches, I gave up. YMMV.
+ * You'll need Python and Perl installed.
+ * For Python install :
+ * [setuptools] (http://pypi.python.org/pypi/setuptools)
+ * pygments
+ * ElementTree
+ * Markdown
+ * For Perl install :
+ * XML::Atom::Feed
+ * XML::RSS::Parser::Lite
+ * XML::Parser::Lite
+ * YAML
+ * SVN::Client
+
+ * I've included a shell script that should skip the next step. Edit
../openjpa/site/trunk/start_markdown.sh and change CMS_BUILD_PATH to point to
the directory where you checked out the CMS tools. Then run start_markdown.sh
this will start the markdown daemon for you. Skip the next bullet if this
works for you.
+
+ * Now go to the directory where you checked out the build tools and run
+ export MARKDOWN_SOCKET=`pwd`/markdown.socket
PYTHONPATH=`pwd`export
+ python markdownd.py
+
+ This will start the markdown daemon process.
+
+ * Edit .../openjpa/site/trunk/build.sh to set the environment variables to
match your environment, or manually run
+ build_site.pl --source-base ${path to site/trunk} --target-base ${path
to site/trunk/target}
+
+ * If the markdown daemon process isn't running you'll get errors like
this.
+ File content/openjpa-logo-contest---run-off.mdtext had processing
errors: Error while rendering output to string
+ Filter 'markdown' couldn't be found or an error occurred. The filter
has to be in the Dotiac::DTL::Filter namespace
+ Can't open markdown socket: No such file or directory at
/home/mikedd/cms/cms/build/lib/Dotiac/DTL/Addon/markup.pm line 56
+
+ * Now if you look at the target directory, you should see .html files for
each page.
+
+ * edit the mdtext files, and repeat the build as needed.
+
+
+
+
