Open Stack

+1 (sorry for the lag, been travelling).

I'd like to start two wiki pages; one collecting goals for the APIs, one for collecting common patterns of use in the APIs (not rules, not even guidelines).

Maybe split each one into "proposed" and "agreed" so that we can keep track of whether there's agreement.

Make sense?



On 23/09/2011, at 5:16 AM, Jorge Williams wrote:

> Starting from a set of goals makes sense to me as well.  I had put
> together a sample set of goals for the PPB proposal a week or so ago and
> some sample guidelines.  You can find them here. Standards for standards
> sake don't make sense to me either.
> 
> http://wiki.openstack.org/Governance/Proposed/APIManagement-sampleGuideline
> s
> 
> Mind you these are just samples.
> 
> I also think it's hard to do this on etherpad.  I think that something
> like a wiki with discus like capabilities would work best.  That way we
> can separate the text from the discussion a bit better.  I understand
> etherpad has the chat think on the side, but it doesn't support threading.
> 
> jOrGe W.
> 
> 
> -----Original Message-----
> From: Bryan Taylor <btaylor at rackspace.com>
> Date: Thu, 22 Sep 2011 13:29:07 -0500
> To: <openstack at lists.launchpad.net>
> Subject: Re: [Openstack] Guidelines for OpenStack APIs
> 
>> The etherpad thing is already somewhat hard to read. I wonder if we
>> could try first to simply get a list of topics that we want guidelines
>> on without first trying to say what the standard is. My experience
>> trying to come up with such standards internally is that they will
>> generate a huge amount of discussion.
>> 
>> Also, we should have some goals for *why* we are creating standards, so
>> that we can push back if people go to far, or defend it if we get push
>> back by people who just don't want any standards. We don't want
>> standards for standards sake, but standards that delivery some specific
>> tangible goals.
>> 
>> On 09/18/2011 10:38 PM, Jonathan Bryce wrote:
>>> After the mailing list discussion around APIs a few weeks back, several
>>> community members asked the Project Policy Board to come up with a
>>> position on APIs. The conclusion of the PPB was that each project's PTL
>>> will own the definition and implementation of the project's official
>>> API, and APIs across all OpenStack projects should follow a set of
>>> guidelines that the PPB will approve. This will allow the APIs to be
>>> tied to the functionality in the project while ensuring a level of
>>> consistency and familiarity across all projects for API consumers.
>>> 
>>> We've started an Etherpad to collect input and comments on suggested
>>> guidelines. It's a little messy but proposed guidelines are set off with
>>> an asterisk (*):
>>> 
>>> http://etherpad.openstack.org/RFC-API-Guidelines
>>> 
>>> Feel free to add comments on the Etherpad, the list or give me feedback
>>> directly.
>>> 
>>> Jonathan.
>>> 
>>> 
>>> 
>>> _______________________________________________
>>> Mailing list: https://launchpad.net/~openstack
>>> Post to     : openstack at lists.launchpad.net
>>> Unsubscribe : https://launchpad.net/~openstack
>>> More help   : https://help.launchpad.net/ListHelp
>> 
>> This email may include confidential information. If you received it in
>> error, please delete it.
>> 
>> 
>> _______________________________________________
>> Mailing list: https://launchpad.net/~openstack
>> Post to     : openstack at lists.launchpad.net
>> Unsubscribe : https://launchpad.net/~openstack
>> More help   : https://help.launchpad.net/ListHelp
> 
> This email may include confidential information. If you received it in error, please delete it.
> 
> 
> _______________________________________________
> Mailing list: https://launchpad.net/~openstack
> Post to     : openstack at lists.launchpad.net
> Unsubscribe : https://launchpad.net/~openstack
> More help   : https://help.launchpad.net/ListHelp

--
Mark Nottingham   http://www.mnot.net/