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
From: Tomas Sedovic tsedovic@redhat.com
--- deltacloud.org/content/contribute.haml | 11 ++ deltacloud.org/content/contribute.mdown | 38 ----- getting_started.txt | 237 ++++++++++++++---------------- 3 files changed, 122 insertions(+), 164 deletions(-) create mode 100644 deltacloud.org/content/contribute.haml delete mode 100644 deltacloud.org/content/contribute.mdown
diff --git a/deltacloud.org/content/contribute.haml b/deltacloud.org/content/contribute.haml new file mode 100644 index 0000000..69b1c34 --- /dev/null +++ b/deltacloud.org/content/contribute.haml @@ -0,0 +1,11 @@ +--- +title: Deltacloud - Contribute +extension: html +filter: + - erb + - markdown + - outline +--- +<toc numbering="off" toc_style="ul" toc_range="h2-h3" /> + +<%= File.open('../getting_started.txt').read %> diff --git a/deltacloud.org/content/contribute.mdown b/deltacloud.org/content/contribute.mdown deleted file mode 100644 index 1426b50..0000000 --- a/deltacloud.org/content/contribute.mdown +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: Deltacloud - Contribute -extension: html -filter: markdown ---- -Contribute -========== - -All development of Deltacloud takes place in the open. Communication is run through the mailing list and all source code changes are tracked publicly. We have two lists, one for [user questions][1], and one for [development discussions and patches][2]. - -[1]: https://fedorahosted.org/mailman/listinfo/deltacloud-users -[2]: https://fedorahosted.org/mailman/listinfo/deltacloud-devel - -You can also join us on the Freenode IRC channel #deltacloud. - -Deltacloud developers are generally available on the IRC channel, but if you do not get a response to a posted question on the IRC channel please ask on the [user mailing list][3]. - -[3]: https://fedorahosted.org/mailman/listinfo/deltacloud-users - -Bugs are tracked in [here][4] for the time being, though we may move them to Bugzilla at some point. - -[4]: https://fedorahosted.org/deltacloud/report - -If you wish to view the gitweb interface of the various components of Deltacloud, they can be found here: - -* [core](http://git.fedorahosted.org/git/?p=deltacloud/core.git;a=summary) -* [portal](http://git.fedorahosted.org/git/?p=deltacloud/portal.git;a=shortlog;h=refs/h...) -* [docs](http://git.fedorahosted.org/git/?p=deltacloud/docs.git;a=shortlog;h=refs/hea...) - -If you would like to contribute code, this is how you get the component you need: - -* git clone [git://git.fedorahosted.org/git/deltacloud/core.git/](git://git.fedorahosted.org/git/deltacloud/core.git/) -* git clone [git://git.fedorahosted.org/git/deltacloud/portal.git/](git://git.fedorahosted.org/git/deltacloud/portal.git/) -* git clone [git://git.fedorahosted.org/git/deltacloud/docs.git/](git://git.fedorahosted.org/git/deltacloud/docs.git/) - -Patches are very welcome. Please send them to the [development list][5]. Patches should be generated with `git` `format-patch` and sent to the list with `git` `send-email`. - -[5]: https://fedorahosted.org/mailman/listinfo/deltacloud-devel diff --git a/getting_started.txt b/getting_started.txt index 86ae3a4..ccb6308 100644 --- a/getting_started.txt +++ b/getting_started.txt @@ -1,110 +1,98 @@ -This is a getting started guide for working with Deltacloud. It's -intended for people who want to get deltacloud up and running for -development purposes. If you want to just install and run deltacloud, -please use the packages provided by your distribution. - - -How the deltacloud pieces fit together --------------------------------------- -Deltacloud consists of 4 main pieces: the deltacloud aggregator, the -deltacloud Web User Interface (WUI), the deltacloud drivers, and -the deltacloud API. The architecture loosely looks like the -picture below: - - ############ - ## ## Native API deltacloud -# Cloud # (i.e. EC2) +------------+ API +------------+ -# Provider # <----------> | deltacloud | <----------> | deltacloud | -# (i.e. EC2) # | driver | | API user | - ## ## +------------+ +------------+ - ########### - ^ - | deltacloud API - | - v - internal deltacloud -+------------+ API +------------+ API +------------+ -| deltacloud | <----------> | deltacloud | <----------> | deltacloud | -| WUI | | aggregator | | API user | -+------------+ +------------+ +------------+ - -In words, what the above picture means is that you have one or more -deltacloud drivers running that translate the deltacloud API into -the native API that the backend cloud speaks (if a backend cloud -speaks deltacloud API natively, then this isn't necessary). Once -the driver is in place, then a deltacloud API user can talk to the -backend cloud using the deltacloud API. One of the deltacloud API -users is the deltacloud aggregator, which can be used to aggregate -disparate backend clouds and make business logic decisions about -which particular cloud an instance should start in. The deltacloud -aggregator speaks to the deltacloud WUI, which provides a -user-friendly web user interface for users. The aggregator can -also be accessed via the deltacloud API to support other -user interfaces. - - -Checking out the components ---------------------------- -If you are reading this document, we assume you have already checked -out the docs git repository. Just in case you haven't, you should -check out the following pieces: - -$ git clone git://git.fedorahosted.org/git/deltacloud/core.git/ - - This is the "core" of deltacloud; it includes both the source code - for the deltacloud API, and the various drivers -$ git clone git://git.fedorahosted.org/git/deltacloud/docs.git/ - - Documentation for deltacloud (including this document) -$ git clone git://git.fedorahosted.org/git/deltacloud/portal.git/ - - The deltacloud aggregator code - -Switch the `docs` and `portal` repositories to the "next" branch: - -$ cd docs -$ git checkout -t origin/next -$ cd ../portal -$ git checkout -t origin/next - -This will get you to the latest and greatest stuff. +Contribute +========== + +All development of Deltacloud takes place in the open. Communication is run through the mailing list and all source code changes are tracked publicly. We have two lists, one for [user questions][1], and one for [development discussions and patches][2]. + +[1]: https://fedorahosted.org/mailman/listinfo/deltacloud-users +[2]: https://fedorahosted.org/mailman/listinfo/deltacloud-devel + +You can also join us on the Freenode IRC channel #deltacloud. + +Deltacloud developers are generally available on the IRC channel, but if you do not get a response to a posted question on the IRC channel please ask on the [user mailing list][3]. + +[3]: https://fedorahosted.org/mailman/listinfo/deltacloud-users + +For the time being, we track bugs on [Fedora Hosted][4], though we may move them to Bugzilla at some point. + +[4]: https://fedorahosted.org/deltacloud/report + +Patches are very welcome. Please send them to the [development list][5]. Patches should be generated with [`git` `format-patch`][6] and sent to the list with [`git` `send-email`][7]. + +[5]: https://fedorahosted.org/mailman/listinfo/deltacloud-devel +[6]: http://kernel.org/pub/software/scm/git/docs/git-format-patch.html +[7]: http://kernel.org/pub/software/scm/git/docs/git-send-email.html + + +Getting the sources +------------------- +The Deltacloud projects consists of two parts: **Core** and **Aggregator**. Core +gives you the API and drivers to various cloud providers. Aggregator (formerly +known as Portal) is a web frontend to the API. + +In addition, there is the **docs** repository that contains the project +documentation and the sources of the http://deltacloud.org website. + +You can browse the code repositories on the web: + +* [core](http://git.fedorahosted.org/git/?p=deltacloud/core.git;a=summary) +* [aggregator](http://git.fedorahosted.org/git/?p=deltacloud/portal.git;a=shortlog;h=refs/h...) +* [docs](http://git.fedorahosted.org/git/?p=deltacloud/docs.git;a=shortlog;h=refs/hea...) + +or download them to your computer: + + $ git clone git://git.fedorahosted.org/git/deltacloud/core.git/ + $ git clone git://git.fedorahosted.org/git/deltacloud/portal.git/ + $ git clone git://git.fedorahosted.org/git/deltacloud/docs.git/ + +The development of the **docs** and **portal** takes place on the `next` branch: + + $ cd path/to/deltacloud/docs + $ git checkout next + $ cd ../portal + $ git checkout next
Installing packages ------------------- -In order to make the deltacloud components work, you'll need to -install at least the following packages (on Fedora 12: your distro's +In order to make the Deltacloud components work, you'll need to +install at least the following packages (on Fedora 12; your distro's packages may vary):
-rubygem-rails -rubygem-daemons -rubygem-gettext_rails -rubygem-sqlite3-ruby -rubygem-compass (this is not yet in Fedora, so you'll have to gem install) -rubygem-haml (this is not yet in Fedora, so you'll have to gem install) + rubygem-rails + rubygem-daemons + rubygem-gettext_rails + rubygem-sqlite3-ruby + rubygem-compass (this is not yet in Fedora, so you'll have to gem install) + rubygem-haml (this is not yet in Fedora, so you'll have to gem install)
If you want to develop using PostgreSQL database instead of the default SQLite, install these, too:
-ruby-postgres -postgresql -postgresql-server + ruby-postgres + postgresql + postgresql-server
-You will also need deltacloud-client gem. You can either install the packaged version: +You will also need **deltacloud-client** gem. You can either install the packaged version:
-$ gem itstall deltacloud-client + $ gem install deltacloud-client
-or build it yourself from the core.git repository: +or build it yourself from the **core** repository:
-$ cd core/client -$ gem build deltacloud-client.gemspec -$ gem install deltacloud-client-*.gem + $ cd core/client + $ gem build deltacloud-client.gemspec + $ gem install deltacloud-client-*.gem
Database -------- -For development purposes we're using SQLite database which is much easier to +For development purposes we're using [SQLite] database which is much easier to set up.
However, we _strongly_ suggest using a more suitable replacement (such as -PostgreSQL) in production. +[PostgreSQL]) in production. + +[SQLite]: http://www.sqlite.org/ +[PostgreSQL]: http://www.postgresql.org/
If you want to set up PostgreSQL, read the following section. SQLite users may skip it and continue with "Setting up the drivers". @@ -115,32 +103,30 @@ PostgreSQL database setup Once you have the proper packages installed you have to setup the postgresql database. As root:
-# /sbin/service postgresql initdb -# /sbin/service postgresql start -# su - postgres -$ psql -postgres=# CREATE USER dcloud WITH PASSWORD 'v23zj59an' CREATEDB; -postgres=# \q -$ exit + # /sbin/service postgresql initdb + # /sbin/service postgresql start + # su - postgres + $ psql + postgres=# CREATE USER dcloud WITH PASSWORD 'v23zj59an' CREATEDB; + postgres=# \q + $ exit
Now you need to edit the pg_hba.conf file -(/var/lib/pgsql/data/pg_hba.conf on Fedora 12): +(`/var/lib/pgsql/data/pg_hba.conf` on Fedora 12):
---------- snip ------------------------------ -local all all trust -host all all 127.0.0.1 255.255.255.255 trust -host all all ::1/128 trust ---------- snip ------------------------------ + local all all trust + host all all 127.0.0.1 255.255.255.255 trust + host all all ::1/128 trust
If you are running on Fedora 12 *only*, to make rake succeed you need to append the following to -/usr/lib/ruby/gems/1.8/gems/activerecord-2.3.4/lib/active_record/connection_adapters/postgresql_adapter.rb: +`/usr/lib/ruby/gems/1.8/gems/activerecord-2.3.4/lib/active_record/connection_adapters/postgresql_adapter.rb`:
- def PGconn.quote_ident(name) - %("#{name}") - end + def PGconn.quote_ident(name) + %("#{name}") + end
-(see http://github.com/mneumann/postgres-pr/issues/unreads#issue/1) +(see http://github.com/mneumann/postgres-pr/issues/unreads#issue/1)
Setting up the drivers @@ -149,37 +135,35 @@ For testing purposes we'll start with the mock driver. Use of the rest of the drivers should be similar, although may require some additional gems be installed.
-$ cd path/to/deltacloud/core/server/bin -$ ./deltacloudd -i mock + $ cd path/to/deltacloud/core/server/bin + $ ./deltacloudd -i mock
-This will run the deltacloud core server on port 3001. +This will run the Deltacloud Core server on port 3001.
-Setting up the aggregator +Setting up the Aggregator ------------------------- -Now we need to setup the aggregator (which includes the UI). -As your user who will run the aggregator: +Now we need to setup the Aggregator (which includes the UI). +As your user who will run the Aggregator: +
+### With SQLite ###
-For SQLite: $ cd path/to/deltacloud/portal/src/config $ cp database.sqlite database.yml
- NOTE: - The .sqlite3 file can be put in any location you desire, - just update the paths in database.yml to point to the correct location. - Also, you will need to take the following 2 steps: - 1. Run rake db:migrate to create the db file and set it to be owned by - the user who will run the aggregator. - 2. Make sure the dir that the above file lives in is also writable by this user. +**Note:** you can edit the "database.yml" file to change the location of the +*.sqlite3 database files.
$ rake db:create:all $ rake db:migrate $ cd <wherever you put it>/db
- You should see the "development.sqlite" file there. +You should see the "development.sqlite3" file there. Make sure it is owned by +the user who will run the Aggregator. + +### With PostgreSQL ###
-For PostgreSQL: $ cd path/to/deltacloud/portal/src $ cp database.pg database.yml $ rake db:create:all @@ -187,17 +171,18 @@ For PostgreSQL: $ rake db:test:prepare
If all went well here, then the database should be ready for you -to start up the aggregator. +to start up the Aggregator.
You can now run the UI:
-$ ./script/server + $ ./script/server
-Which will start up the aggregator UI on port 3000. +Which will start up the Aggregator UI on port 3000.
Checking out the UI ------------------- -Now that you have all of the components running, you -should be able to point your web browser at localhost:3000 -and see the UI. Happy hacking! +Now that you have all of the components running, you should be able to point +your web browser at http://localhost:3000 and see the Aggregator page. + +**Happy hacking!**
+Contribute +==========
+All development of Deltacloud takes place in the open. Communication is run through the mailing list and all source code changes are tracked publicly. We have two lists, one for [user questions][1], and one for [development discussions and patches][2].
+[1]: https://fedorahosted.org/mailman/listinfo/deltacloud-users +[2]: https://fedorahosted.org/mailman/listinfo/deltacloud-devel
+You can also join us on the Freenode IRC channel #deltacloud.
+Deltacloud developers are generally available on the IRC channel, but if you do not get a response to a posted question on the IRC channel please ask on the [user mailing list][3].
+[3]: https://fedorahosted.org/mailman/listinfo/deltacloud-users
+For the time being, we track bugs on [Fedora Hosted][4], though we may move them to Bugzilla at some point.
We actually have a component in Bugzilla, so this is not accurate. They can view open bugs at: https://bugzilla.redhat.com/buglist.cgi?query_format=advanced&bug_status... and file a new one at: https://bugzilla.redhat.com/enter_bug.cgi?product=Virtualization%20Tools&...
+Patches are very welcome. Please send them to the [development list][5]. Patches should be generated with [`git` `format-patch`][6] and sent to the list with [`git` `send-email`][7].
+[5]: https://fedorahosted.org/mailman/listinfo/deltacloud-devel +[6]: http://kernel.org/pub/software/scm/git/docs/git-format-patch.html +[7]: http://kernel.org/pub/software/scm/git/docs/git-send-email.html
I kind of the think the whole above part should be in contribute.haml, rather than here. getting_started.txt should probably really be README, so it is a more standard name anyway, so if someone checks out the docs repo per the directions, they can just read the README to get going.
+Getting the sources +------------------- +The Deltacloud projects consists of two parts: **Core** and **Aggregator**. Core
singular 'project' ^
+gives you the API and drivers to various cloud providers. Aggregator (formerly +known as Portal) is a web frontend to the API.
Should probably also mention Core provides a client
+In addition, there is the **docs** repository that contains the project +documentation and the sources of the http://deltacloud.org website.
+You can browse the code repositories on the web:
+* [core](http://git.fedorahosted.org/git/?p=deltacloud/core.git;a=summary ) +* [aggregator]( http://git.fedorahosted.org/git/?p=deltacloud/portal.git;a=shortlog;h=refs/h... ) +* [docs]( http://git.fedorahosted.org/git/?p=deltacloud/docs.git;a=shortlog;h=refs/hea... )
+or download them to your computer:
- $ git clone git://git.fedorahosted.org/git/deltacloud/core.git/
- $ git clone git://git.fedorahosted.org/git/deltacloud/portal.git/
- $ git clone git://git.fedorahosted.org/git/deltacloud/docs.git/
Please add '--branch next' to the end of each of the above commands, this will check out next directly. Perhaps also clarify that the above commands are for the latest development version, and that a stable version can be checked out by omitting the '--branch next' part of the command.
+The development of the **docs** and **portal** takes place on the `next`
branch:
- $ cd path/to/deltacloud/docs
- $ git checkout next
- $ cd ../portal
- $ git checkout next
The above steps can be removed.
Installing packages
-In order to make the deltacloud components work, you'll need to -install at least the following packages (on Fedora 12: your distro's +In order to make the Deltacloud components work, you'll need to +install at least the following packages (on Fedora 12; your distro's packages may vary):
-rubygem-rails -rubygem-daemons -rubygem-gettext_rails -rubygem-sqlite3-ruby -rubygem-compass (this is not yet in Fedora, so you'll have to gem install) -rubygem-haml (this is not yet in Fedora, so you'll have to gem install)
- rubygem-rails
- rubygem-daemons
- rubygem-gettext_rails
- rubygem-sqlite3-ruby
- rubygem-compass (this is not yet in Fedora, so you'll have to gem
install)
- rubygem-haml (this is not yet in Fedora, so you'll have to gem
install)
If you want to develop using PostgreSQL database instead of the default SQLite, install these, too:
-ruby-postgres -postgresql -postgresql-server
- ruby-postgres
- postgresql
- postgresql-server
-You will also need deltacloud-client gem. You can either install the packaged version: +You will also need **deltacloud-client** gem. You can either install the packaged version:
-$ gem itstall deltacloud-client
- $ gem install deltacloud-client
-or build it yourself from the core.git repository: +or build it yourself from the **core** repository:
-$ cd core/client -$ gem build deltacloud-client.gemspec -$ gem install deltacloud-client-*.gem
- $ cd core/client
- $ gem build deltacloud-client.gemspec
- $ gem install deltacloud-client-*.gem
Database
-For development purposes we're using SQLite database which is much easier to +For development purposes we're using [SQLite] database which is much easier to set up.
However, we _strongly_ suggest using a more suitable replacement (such as -PostgreSQL) in production. +[PostgreSQL]) in production.
+[SQLite]: http://www.sqlite.org/ +[PostgreSQL]: http://www.postgresql.org/
If you want to set up PostgreSQL, read the following section. SQLite users may skip it and continue with "Setting up the drivers". @@ -115,32 +103,30 @@ PostgreSQL database setup Once you have the proper packages installed you have to setup the postgresql database. As root:
-# /sbin/service postgresql initdb -# /sbin/service postgresql start -# su - postgres -$ psql -postgres=# CREATE USER dcloud WITH PASSWORD 'v23zj59an' CREATEDB; -postgres=# \q -$ exit
- # /sbin/service postgresql initdb
- # /sbin/service postgresql start
- # su - postgres
- $ psql
- postgres=# CREATE USER dcloud WITH PASSWORD 'v23zj59an' CREATEDB;
- postgres=# \q
- $ exit
Now you need to edit the pg_hba.conf file -(/var/lib/pgsql/data/pg_hba.conf on Fedora 12): +(`/var/lib/pgsql/data/pg_hba.conf` on Fedora 12):
---------- snip ------------------------------ -local all all trust -host all all 127.0.0.1 255.255.255.255 trust -host all all ::1/128 trust ---------- snip ------------------------------
- local all all trust
- host all all 127.0.0.1 255.255.255.255 trust
- host all all ::1/128 trust
If you are running on Fedora 12 *only*, to make rake succeed you need to append the following to
-/usr/lib/ruby/gems/1.8/gems/activerecord-2.3.4/lib/active_record/connection_adapters/postgresql_adapter.rb:
+`/usr/lib/ruby/gems/1.8/gems/activerecord-2.3.4/lib/active_record/connection_adapters/postgresql_adapter.rb`:
def PGconn.quote_ident(name)%("#{name}")end
- def PGconn.quote_ident(name)
%("#{name}")- end
-(see http://github.com/mneumann/postgres-pr/issues/unreads#issue/1) +(see http://github.com/mneumann/postgres-pr/issues/unreads#issue/1)
Setting up the drivers @@ -149,37 +135,35 @@ For testing purposes we'll start with the mock driver. Use of the rest of the drivers should be similar, although may require some additional gems be installed.
-$ cd path/to/deltacloud/core/server/bin -$ ./deltacloudd -i mock
- $ cd path/to/deltacloud/core/server/bin
- $ ./deltacloudd -i mock
-This will run the deltacloud core server on port 3001. +This will run the Deltacloud Core server on port 3001.
-Setting up the aggregator
+Setting up the Aggregator
-Now we need to setup the aggregator (which includes the UI). -As your user who will run the aggregator: +Now we need to setup the Aggregator (which includes the UI).
I think the part at the end in parentheses is unneeded ^.
+As your user who will run the Aggregator:
+### With SQLite ###
-For SQLite: $ cd path/to/deltacloud/portal/src/config $ cp database.sqlite database.yml
- NOTE:
- The .sqlite3 file can be put in any location you desire,
- just update the paths in database.yml to point to the correct
location.
We need to keep this line ^
- Also, you will need to take the following 2 steps:
- Run rake db:migrate to create the db file and set it to be owned by
the user who will run the aggregator.
- Make sure the dir that the above file lives in is also writable by
this user.
Line 2 ^ needs to stay, though if you want to move it to the small section below on setting perms, that is fine.
+**Note:** you can edit the "database.yml" file to change the location of the +*.sqlite3 database files.
$ rake db:create:all $ rake db:migrate $ cd <wherever you put it>/db
- You should see the "development.sqlite" file there.
+You should see the "development.sqlite3" file there. Make sure it is owned by +the user who will run the Aggregator.
+### With PostgreSQL ###
-For PostgreSQL: $ cd path/to/deltacloud/portal/src $ cp database.pg database.yml $ rake db:create:all @@ -187,17 +171,18 @@ For PostgreSQL: $ rake db:test:prepare
If all went well here, then the database should be ready for you -to start up the aggregator. +to start up the Aggregator.
You can now run the UI:
-$ ./script/server
- $ ./script/server
-Which will start up the aggregator UI on port 3000. +Which will start up the Aggregator UI on port 3000.
don't think we need 'UI' here. Since it is a web app, I think the ui is expected.
Checking out the UI
-Now that you have all of the components running, you -should be able to point your web browser at localhost:3000 -and see the UI. Happy hacking!
Not that I am against humor, but I think we should kill 'happy hacking' to keep this more professional.
+Now that you have all of the components running, you should be able to
point +your web browser at http://localhost:3000 and see the Aggregator page.
+**Happy hacking!**
1.6.6.1
deltacloud-devel mailing list deltacloud-devel@lists.fedorahosted.org https://fedorahosted.org/mailman/listinfo/deltacloud-devel
Looks good, couple minor points inline, then can be pushed.
On Wed, Mar 24, 2010 at 12:02 PM, tsedovic@redhat.com wrote:
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
^^^ s/end/and
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/
I would just make this ^ file:///path/to/docs/deltacloud.org/output/ as we dont know if they will have it in home dir.
Also, it might be worth adding that you can run 'webby autobuild' to run it as a simple webrick server, which also happens to auto-launch in your browser, which I find kind of handy.
+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-- 1.6.6.1
deltacloud-devel mailing list deltacloud-devel@lists.fedorahosted.org https://fedorahosted.org/mailman/listinfo/deltacloud-devel
deltacloud-devel@lists.fedorahosted.org
-
jason.guiditta -
Tomas Sedovic