Hi!
So, I've tried to review the basic structure of deltacloud.apache.org.
There is a current state described in the attachment and then a revised
version according to my idea. I've added some comments. It's just a
basic structure of a web, but I think it's good to give you an
impression of what I'm thinking about. I'm still working on the
Developers section - there is a huge amount of information, which needs
to be dived into a smaller parts and to be connected in easily
accessible way.
Please, feel free to let me know your opinion.
--
Dagmar Husarova
Intern | Red Hat. Inc.
Home
Deltacloud gives you
News
Download
Get Deltacloud
Getting the sources
The Deltacloud Ruby Client
libdeltacloud
Your name here
*Get Deltacloud should probably be a single page. The description how to
download and install Deltacloud is now split into two parts in Download and in
Documentation/Installation. So it would be better to move
Documentation/Installation to Get Deltacloud. I would also change the order of
Installation page a little bit: 1. Installation dependencies 2. Installation of
Deltacloud itself 3. quick-start guide. Getting the sources is already a part
of Developers section. The Deltacloud Ruby Client and Other HTTP clients should
by moved to a new page Clients (located in Developers section>Documentation).
The same with libdeltacloud. Your name here makes no sense to me at this page,
I think it's better to write something like that to the homepage and also to
developers page.*
Developers *The ideas how to restructure this section are described below.*
Setting up the developer environment
Getting the sources
Development dependencies
Building from source and installing the Deltacloud gem
Contribute to Deltacloud
Overview of the Deltacloud directory structure
Forming and sending patches
Use the Deltacloud github mirror
Writing a new cloud provider driver
Writing and running tests
Licensing - the Apache Individual Contributor License Agreement
Documentation *As the whole section is the matter of interest mainly for
developers, it should be included in the Developers section - apart from
installation. Installation together with Get Deltacloud creates a single page.*
Installation
Install Deltacloud
Installation of Deltacloud itself
Installation dependencies
Hello Deltacloud!, quick-start guide
Running the Deltacloud server
The Deltacloud ruby client *move to Client page*
Other HTTP clients - cURL *move to Client page*
REST API
Drivers
Dynamic driver switching
Driver functionality and Credentials
Notes on specific drivers
EC2 Driver
Eucalyptus Driver
RHEV-M Driver
VMware vSphere Driver
OpenStack Driver
Rackspace Driver
RimuHosting
OpenNebula
IBM Smartcloud Driver
Ruby Client
API Docs' - just a link
Basics
Connecting to a Deltacloud provider
Listing realms
Listing hardware profiles
Listing images
Listing instances
Launching instances
Manipulating instances
Libdeltacloud
Contact
mailing list
irc channel
Teambox
github
Apache JIRA
My idea:
Home
I think, there should be only some basic info on a homepage copying the
structure of the whole web, e.g. "Why Delta cloud?" - the basic principle and
what it gives you and the link to a page with more details; "How can I
contribute (send a bug report, write or run tests, write a new cloud provider
driver etc.)" - with link to section for developers.
News
About - more details about Deltacloud priniciples, advantages and stuff like
that
Get Deltacloud
Installation dependencies
Installation of Deltacloud
Quick-start guide
Developers - list of subpages:
Getting the sources and dependencies
Install dependencies
Getting the sources
Building from a source and installing Deltacloud gem
Overview of the Deltacloud directory structure
Contribute to Deltacloud
Use the Deltacloud github mirror
Forming and sending patches
Writing a new cloud provider driver
Writing and running tests
License Agreement
Documentation
REST API
Drivers
Clients
Libdeltacloud
Found a bug?
*My idea: the Developers first page should contain only a short text or a list
like this:
Get the sources
Contribute to Deltacloud
See the documentation
Found a bug? Report it to Apache JIRA.
See Teambox for the latest task list.*
Contact
mailing list
irc channel
