| 1 |
--- |
| 2 |
# Copyright (C) 2009-2011 the original author or authors. |
| 3 |
# See the notice.md file distributed with this work for additional |
| 4 |
# information regarding copyright ownership. |
| 5 |
# |
| 6 |
# Licensed under the Apache License, Version 2.0 (the "License"); |
| 7 |
# you may not use this file except in compliance with the License. |
| 8 |
# You may obtain a copy of the License at |
| 9 |
# |
| 10 |
# http://www.apache.org/licenses/LICENSE-2.0 |
| 11 |
# |
| 12 |
# Unless required by applicable law or agreed to in writing, software |
| 13 |
# distributed under the License is distributed on an "AS IS" BASIS, |
| 14 |
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 15 |
# See the License for the specific language governing permissions and |
| 16 |
# limitations under the License. |
| 17 |
|
| 18 |
title: Building |
| 19 |
--- name:overview |
| 20 |
|
| 21 |
# ${project_name} Site |
| 22 |
How the website works |
| 23 |
|
| 24 |
--- name:content pipeline:jade |
| 25 |
|
| 26 |
.left |
| 27 |
h1 How it works |
| 28 |
.right |
| 29 |
:markdown |
| 30 |
|
| 31 |
The *${project_name}* documentation and site is created using Scalate |
| 32 |
and is stored in git in the same [source control system as the |
| 33 |
code](source.html) |
| 34 |
|
| 35 |
**Note:** For code highlighting you will need to |
| 36 |
[install](http://pygments.org/download/) |
| 37 |
[http://pygments.org/](http://pygments.org). |
| 38 |
|
| 39 |
.left |
| 40 |
h1 Editing the source code |
| 41 |
.right |
| 42 |
:markdown |
| 43 |
|
| 44 |
If you [grab the source code](source.html) you will find the site |
| 45 |
source in the *${project_id}-website* directory. The website is |
| 46 |
also built using Maven so, you would |
| 47 |
|
| 48 |
cd ${project_id}-website |
| 49 |
mvn install |
| 50 |
|
| 51 |
If you want to edit the files in your text editor and be able to |
| 52 |
immediately see the site re-rendered in a browser then use |
| 53 |
|
| 54 |
mvn jetty:run |
| 55 |
|
| 56 |
You can now surf the site and see changes immediately. |
| 57 |
|
| 58 |
If you are on OS X then we highly recommend |
| 59 |
[TextMate](http://macromates.com/) as a great editor which supports |
| 60 |
Textile and Markdown |
| 61 |
|
| 62 |
.left |
| 63 |
h1 Deploying the site |
| 64 |
.right |
| 65 |
:markdown |
| 66 |
|
| 67 |
The site is automatically deployed by the CI builds, so you can |
| 68 |
simply wait for the changes to be automatically pushed to the project |
| 69 |
site. |
| 70 |
|
| 71 |
You can manually deploy the site using Maven: |
| 72 |
|
| 73 |
mvn deploy |
| 74 |
|
| 75 |
Since deployment to our webserver requires proper authorization, |
| 76 |
you will need to add an entry to your ~/.m2/settings.xml file simlilar |
| 77 |
to: |
| 78 |
|
| 79 |
{pygmentize:: xml} |
| 80 |
<server> |
| 81 |
<id>${project_id}-website</id> |
| 82 |
<username>xxxx</username> |
| 83 |
<password>xxxxx</password> |
| 84 |
</server> |
| 85 |
{pygmentize} |