Author: cbrisson
Date: Thu Jun 2 13:52:27 2016
New Revision: 1746576
URL: http://svn.apache.org/viewvc?rev=1746576&view=rev
Log:
[site] adapt site building page (typos and more infos) 2/2
Modified:
velocity/site/cms/trunk/content/site-building.mdtext
Modified: velocity/site/cms/trunk/content/site-building.mdtext
URL:
http://svn.apache.org/viewvc/velocity/site/cms/trunk/content/site-building.mdtext?rev=1746576&r1=1746575&r2=1746576&view=diff
==============================================================================
--- velocity/site/cms/trunk/content/site-building.mdtext (original)
+++ velocity/site/cms/trunk/content/site-building.mdtext Thu Jun 2 13:52:27
2016
@@ -17,17 +17,46 @@ In short: This svn repository is only in
Apache Velocity uses the [Apache Content Management
System](http://www.apache.org/dev/cms.html) to manage its site.
+For the time being, the site is not yet *hosted* by the CMS (which is not yet
accepting new sites before undergoing a machine transition), so the site still
has to be build locally. Please refer to the next section. The rest of this
section is *not yet applicable*.
+
To just edit one page, all you need is the bookmarklet found
[here](https://cms.apache.org/#bookmark)
-$If you're a commiter, you'll be able to push your edits by yourself on the
production site. Otherwise, the CMS will let you generate a diff file that you
can [send to the devs](/contact.html).
+If you're a commiter, you'll be able to push your edits by yourself on the
production site. Otherwise, the CMS will let you generate a diff file that you
can [send to the devs](/contact.html).
-Commiters can also commit changes to [the site under
svn](http://svn.apache.org/repos/asf/velocity/site/cms/trunk/) and trigger a
publication in production from the CMS (TODO - URL)
+Commiters can also commit changes to [the site under
svn](http://svn.apache.org/repos/asf/velocity/site/cms/trunk/) and trigger a
publication in production from the CMS.
### Building the Site
-To build the site locally, you need a local checkout of
[https://svn.apache.org/repos/infra/websites/cms](https://svn.apache.org/repos/infra/websites/cms)
(then refer to the
[STATUS](https://svn.apache.org/repos/infra/websites/cms/STATUS) file).
+To build the site locally, you'll need a local checkout of the [Apache
CMS](https://svn.apache.org/repos/infra/websites/cms) (check the
[STATUS](https://svn.apache.org/repos/infra/websites/cms/STATUS) file) and of
course a local checkout of [Velocity's site
sources](https://svn.apache.org/repos/asf/velocity/site).
+
+Typically, you'll have to:
-You'll of course also need a local checkout of the site sources,
[https://svn.apache.org/repos/asf/velocity/site(https://svn.apache.org/repos/asf/velocity/site)
(the sources for the cms are in /cms/trunk, but the process needs the whole
site).
+1. define the environment variable MARKDOWN_SOCKET to something like
/tmp/markdown
+2. launch the CMS markdown daemon `apache-cms/build/markdownd.py`
+3. run `apache-cms/build/build_site.pl --source-base velocity/site/cms/trunk
--target-base velocity/site/target` (adapt the paths)
+4. copy the generated files from site/target/content to site/production
(including the hidden file site/target/.htaccess)
+5. check the result then commit
+
+Here's a bash script that you can reuse:
+
+ #!/bin/bash
+
+ export MARKDOWN_SOCKET=/tmp/markdown
+ CMS=~/projects/velocity/apache_cms
+ VELOCITY=~/projects/velocity
+
+ if [[ `pidof markdownd.py` == "" ]]; then
+ $CMS/build/markdownd.py
+ fi
+
+ find $VELOCITY/site/cms/trunk/ -name "*~" | xargs rm -v
+ rm -rf $VELOCITY/site/target
+
+ $CMS/build/build_site.pl --source-base $VELOCITY/site/cms/trunk
--target-base $VELOCITY/site/target
+ cp -r $VELOCITY/site/target/content/* $VELOCITY/site/production/
+ cp $VELOCITY/site/target/content/.htaccess $VELOCITY/site/production/
+
+ svn status $VELOCITY/site/production/
### Additional Notes
