incubator-deltacloud-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mar...@redhat.com
Subject [PATCH 3/3] INCOMPLETE! Updates Site docs - information for developers
Date Wed, 31 Aug 2011 09:07:01 GMT
From: marios <marios@redhat.com>


Signed-off-by: marios <marios@redhat.com>
---
 site/content/_navigation.haml |    2 +-
 site/content/contribute.mdown |  101 ---------------------------------------
 site/content/developers.mdown |  106 +++++++++++++++++++++++++++++++++++++++++
 site/content/roadmap.mdown    |    9 +--
 4 files changed, 110 insertions(+), 108 deletions(-)
 delete mode 100644 site/content/contribute.mdown
 create mode 100644 site/content/developers.mdown

diff --git a/site/content/_navigation.haml b/site/content/_navigation.haml
index 6586267..0ad7e81 100644
--- a/site/content/_navigation.haml
+++ b/site/content/_navigation.haml
@@ -3,7 +3,7 @@ filter: haml
 ---
 - menu = [ { :href => "index.html", :title => "Deltacloud Home", :text => "Home"
}, |
   { :href => "download.html", :title => "Get the latest releases", :text => "Download"
}, |
-  { :href => "contribute.html", :title => "Information about design/development process",
:text => "Developers" }, |
+  { :href => "developers.html", :title => "Information for developers", :text =>
"Developers" }, |
   { :href => "documentation.html", :title => "Project documentation", :text => "Documentation"
}, |
   { :href => "contact.html", :title => "Contact us!", :text => "Contact"} ] |
 
diff --git a/site/content/contribute.mdown b/site/content/contribute.mdown
deleted file mode 100644
index e9fd595..0000000
--- a/site/content/contribute.mdown
+++ /dev/null
@@ -1,101 +0,0 @@
----
-title: Deltacloud - Contribute
-extension: html
-filter:
-  - markdown
-  - outline
----
-Help make Deltacloud better
-===========================
-
-<toc class="toc" numbering="off" toc_style="ul" toc_range="h2-h3" />
-
-All development of Deltacloud takes place in the open. Communication is run
-through the mailing list and all source code changes are tracked publicly.
-
-* <strong>Mailing Lists</strong><br/>
-  For Deltacloud API: [deltacloud-dev@incubator.apache.org](mailto:deltacloud-dev@incubator.apache.org).
-  To subscribe to it, send an email to [deltacloud-dev-subscribe@incubator.apache.org](deltacloud-dev-subscribe@incubator.apache.org).
You can also view [Archive][1] in case you are missing something.
-
-  [1]: http://mail-archives.apache.org/mod_mbox/incubator-deltacloud-dev/
-* <strong>IRC</strong><br/>
-  You can also join us on the Freenode IRC channel #deltacloud. Deltacloud
-  developers are generally available on the IRC channel
-* <strong>Bugs</strong><br/>
-  We track bugs in [Apache JIRA][2]. You can [view open bugs][view-bugs] or
-  [file a new one][new-bug] there.
-
-  [2]: https://issues.apache.org/jira/browse/DTACLOUD
-  [view-bugs]: https://issues.apache.org/jira/browse/DTACLOUD
-  [new-bug]: https://issues.apache.org/jira/secure/CreateIssue!default.jspa
-* <strong>Patches</strong><br/>
-  Patches are very welcome. Please send them to the [development
-  list][3]. Patches should be generated with [`git`&nbsp;`format-patch`][4]
-  and sent to the list with [`git`&nbsp;`send-email`][5].
-* <strong>Roadmap</strong><br/>
-  We maintain our roadmap in
-  [teambox](https://teambox.com/projects/deltacloud/task_lists) so that
-  anyone can comment on tasks and suggest new ones.
-
-  [3]: http://mail-archives.apache.org/mod_mbox/incubator-deltacloud-dev/
-  [4]: http://kernel.org/pub/software/scm/git/docs/git-format-patch.html
-  [5]: http://kernel.org/pub/software/scm/git/docs/git-send-email.html
-
-Getting the sources
--------------------
-
-Then Deltacloud Core gives you the API and drivers to various cloud providers.
-It also provides a client library and a commandline interface.
-
-The Deltacloud Core repository is hosted on Apache Incubator.
-Apache uses Subversion, but there is a git mirror available:
-
-    $ mkdir deltacloud
-    $ cd deltacloud
-    $ git clone git://git.apache.org/deltacloud.git core
-
-You can find the Subversion repository at: <https://svn.apache.org/repos/asf/incubator/deltacloud>.
-
-Required packages
------------------
-In order to make the Deltacloud components work, you'll need to
-have the following packages installed (on Fedora 14; the names may vary on
-your distro):
-
-    ruby
-    ruby-devel
-    rubygem-rake
-    gcc-c++
-    libxml2-devel
-    libxslt-devel
-
-**Note:** these packages are necessary for building all the required ruby gems
-that Deltacloud requires. If you want to install the gems using your system's
-package manager (yum, apt, ports, etc.) you won't need to install these
-packages manually.
-
-To install all required ruby gems manually you should run:
-
-    $ yum install rubygem-haml rubygem-sinatra rubygem-thin rubygem-json \
-      rubygem-net-json rubygem-rack-accept rubygem-nokogiri rubygem-aws \
-      rubygem-rest-client
-
-Installing the Deltacloud Core
-------------------------------
-
-First, you need to install the server that will give you the Deltacloud API:
-
-    $ cd path/to/deltacloud/core/server
-    $ rake package
-    $ sudo gem install pkg/deltacloud-core-<version>.gem
-
-Then install the client library:
-
-    $ cd path/to/deltacloud/core/client
-    $ rake package
-    $ sudo gem install pkg/deltacloud-client-<version>.gem
-
-Once you have the client installed, run the following command:
-
-    $ cd path/to/deltacloud/core/client
-    $ rake fixtures
diff --git a/site/content/developers.mdown b/site/content/developers.mdown
new file mode 100644
index 0000000..435dce6
--- /dev/null
+++ b/site/content/developers.mdown
@@ -0,0 +1,106 @@
+---
+title: Deltacloud - Information for Developers
+extension: html
+filter:
+  - markdown
+  - outline
+---
+# Contribute to the Deltacloud Project
+
+[Apache](http://www.apache.org/ "The Apache Software Foundation") Deltacloud is
+free, open source software licensed under the
+[apache license](http://www.apache.org/licenses/LICENSE-2.0 "The Apache License").
+Please feel free to [contact us](contact.html) if you have any questions about the
+project or with any suggestions on how to improve Deltacloud. The Deltacloud
+developer community is open to anyone that wants to contribute!
+
+This page contains information for developers:
+
+<toc class="toc" numbering="off" toc_style="ul" toc_range="h2-h3" />
+
+
+## Setting up the developer environment
+
+The information here is about setting up a dev environment for Deltacloud. If you
+are interested in first trying out Deltacloud, you should instead follow the
+instructions in the [Download](download.html) page. If you install the Deltacloud gem
+as per the download instructions, the 'gem' command will ensure that you have also
+installed all the Ruby Gems that Deltacloud depends on.
+
+### Getting the sources
+
+Deltacloud provides the API server and drivers to various cloud providers.
+It also includes a ruby client library and a commandline interface.
+
+The Deltacloud repository is hosted at the Apache Software Foundation.
+Apache uses Subversion, but there is also a git mirror available. Many of
+the Deltacloud developers use the [git version control system](http://git-scm.com/download)
+and 'git format-patch' is the preferred way of making patches. If your system comes with
a
+package manager you can use it to install git (e.g., ***sudo yum install git***, or,
+***sudo apt-get install git***). There are also [git binaries](http://git-scm.com/download)
+for other systems.
+
+    $ mkdir deltacloud
+    $ cd deltacloud
+    $ git clone git://git.apache.org/deltacloud.git core
+
+You can find the Subversion repository at: <https://svn.apache.org/repos/asf/incubator/deltacloud>.
+
+### Required packages
+
+In order to make the Deltacloud components work, you'll need to
+have the following packages installed (on Fedora 14; the names may vary on
+your distro):
+
+    ruby
+    ruby-devel
+    rubygem-rake
+    gcc-c++
+    libxml2-devel
+    libxslt-devel
+
+**Note:** these packages are necessary for building all the required ruby gems
+that Deltacloud requires. If you want to install the gems using your system's
+package manager (yum, apt, ports, etc.) you won't need to install these
+packages manually.
+
+To install all required ruby gems manually you should run:
+
+    $ yum install rubygem-haml rubygem-sinatra rubygem-thin rubygem-json \
+      rubygem-net-json rubygem-rack-accept rubygem-nokogiri rubygem-aws \
+      rubygem-rest-client
+
+### Building from source and installing Deltacloud
+
+First, you need to install the server that will give you the Deltacloud API:
+
+    $ cd path/to/deltacloud/core/server
+    $ rake package
+    $ sudo gem install pkg/deltacloud-core-<version>.gem
+
+Then install the client library:
+
+    $ cd path/to/deltacloud/core/client
+    $ rake package
+    $ sudo gem install pkg/deltacloud-client-<version>.gem
+
+Once you have the client installed, run the following command:
+
+    $ cd path/to/deltacloud/core/client
+    $ rake fixtures
+
+### Use the Deltacloud github mirror
+
+## Contribute to Deltacloud
+
+### Overview of the Deltacloud directory structure
+
+### Forming and sending patches
+
+### Writing a new cloud provider driver
+
+### Writing and running tests
+
+### Licensing - the Apache Individual Contributor License Agreement
+
+
diff --git a/site/content/roadmap.mdown b/site/content/roadmap.mdown
index 4564844..e735975 100644
--- a/site/content/roadmap.mdown
+++ b/site/content/roadmap.mdown
@@ -23,15 +23,12 @@ and a longer list of items we will address after the next release, roughly
 in order of priority.
 
 If you have anything you'd like to see added to the roadmap, or think that
-some items should receive more attention, please let us know on the
-[mailing list][1]. Of course, the quickest way to get anything into
-Deltacloud is to [send us patches][2] &mdash; we will of course take patches
+some items should receive more attention, please [let us know](contact.html).
+Of course, the quickest way to get anything into
+Deltacloud is to send us patches; we will of course take patches
 for anything, regardless of whether they adress items on the roadmap or
 anything else.
 
-[1]: /contribute.html
-[2]: /contribute.html
-
 
 <toc numbering="off" toc_style="ul" toc_range='h2-h3' />
 
-- 
1.7.3.4


Mime
View raw message