From: Tomas Sedovic tsedovic@redhat.com
--- building_website.txt | 57 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 files changed, 57 insertions(+), 0 deletions(-) create mode 100644 building_website.txt
diff --git a/building_website.txt b/building_website.txt new file mode 100644 index 0000000..1f3a7f8 --- /dev/null +++ b/building_website.txt @@ -0,0 +1,57 @@ +How to Build the Deltacloud Website +=================================== + + +Requirements +------------ + +You need to have Ruby version 1.8 installed, along with the following gems: + +* webby +* haml +* rdiscount + +Depending on your distribution, you may need to add the directory with `webby` +executable to your $PATH. + + +Building the Website +-------------------- + +Deltacloud website is created using [Webby][1]. It takes a website defined by a +set of layouts, templates and content files, runs a count of filters on them +end produces a static web structure that can be directly posted to a webserver +or displayed in a browser. + +[1]: http://webby.rubyforge.org/ + +To do this, go to the `deltacloud.org` directory and run `webby`: + + $ cd path/to/docs/deltacloud.org + $ webby + +The website will be generated in the `deltacloud.org/output/` directory. To +view it, you can point your browser to that directory. + + file:///home/username/path/to/docs/deltacloud.org/output/ + + +File Structure +-------------- + +docs/ + - documentation for Deltacloud + +deltacloud.org/ + - the Deltacloud website + +deltacloud.org/content/ + - the pages that are displayed on the website + +deltacloud.org/layouts/ + - the structure of the website -- including logo, navigation, + footers, etc. + +deltacloud.org/output/ + - the final version of the site -- this is what you want to view in a + web browser