incubator-deltacloud-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From David Lutterkort <lut...@redhat.com>
Subject Re: [PATCH 2/3] Updates Site docs - easy Download/Get started instructions, with examples using the ruby client, deltacloudc, and curl. Also updated contact information page for project.
Date Wed, 31 Aug 2011 23:24:11 GMT
On Wed, 2011-08-31 at 12:07 +0300, marios@redhat.com wrote:
> From: marios <marios@redhat.com>
> 
> 
> Signed-off-by: marios <marios@redhat.com>

ACK.

> diff --git a/site/content/contact.mdown b/site/content/contact.mdown

Nice .. definitely more end-user friendly.

> new file mode 100644
> index 0000000..17a97ec
> --- /dev/null
> +++ b/site/content/contact.mdown

> +* We track bugs in [Apache JIRA](https://issues.apache.org/jira/browse/DTACLOUD). If
you are
> +  have found a problem with Deltacloud you can check if it is already known to the Deltacloud

Small typo: s/are have/have/

> diff --git a/site/content/download.mdown b/site/content/download.mdown
> index dee8181..b531579 100644

I like ths content, but I think it should go into something like 'Quick
start' or 'Installation instructions' underneath Documentation, or as a
separate toplevel link.

The download page should be very short, and just list where the tarballs
are, what gems to install (should be in the order Server, Client,
libdeltacloud) and pointers to svn and git. Basically, a reminder for
people who just want to get the bits quickly.

> --- a/site/content/download.mdown
> +++ b/site/content/download.mdown
> @@ -4,25 +4,200 @@ extension: html
>  filter: markdown
 
> -### Deltacloud Core ###
> +Deltacloud provides the API server and drivers necessary for connecting
> +to the [cloud providers](./drivers.html#providers "Deltacloud drivers").

I think this should also link to /documentation.html#credentials, since
what credentials to supply is the first question any user has. We should
probably add a sentence to that page along the lines of

   For details on the capabilities of each driver
   see /drivers.html#providers

David



Mime
View raw message