Re: [openstack-dev] [All] Proposal to add examples/usecase as part of new features / cli / functionality patches

2014-11-28 Thread Deepak Shetty
On Fri, Nov 28, 2014 at 10:32 PM, Steve Gordon wrote: > - Original Message - > > From: "Deepak Shetty" > > To: "OpenStack Development Mailing List (not for usage questions)" < > openstack-dev@lists.openstack.org> > > > > But isn't *-specs comes very early in the process where you have an

Re: [openstack-dev] [All] Proposal to add examples/usecase as part of new features / cli / functionality patches

2014-11-28 Thread Steve Gordon
- Original Message - > From: "Deepak Shetty" > To: "OpenStack Development Mailing List (not for usage questions)" > > > But isn't *-specs comes very early in the process where you have an > idea/proposal of a feature, u don't have it yet implemented. Hence specs > just end up with Para'

Re: [openstack-dev] [All] Proposal to add examples/usecase as part of new features / cli / functionality patches

2014-11-27 Thread Sridhar Gaddam
Current *-specs already include sections like "Data Model Impact/REST Api Impact etc". So what about including a new section like "UseCase examples", which can be updated as a separate patch once the associated CLI changes are merged? Thanks, --Sridhar. On 11/27/2014 10:19 AM, Deepak Shetty wr

Re: [openstack-dev] [All] Proposal to add examples/usecase as part of new features / cli / functionality patches

2014-11-27 Thread Deepak Shetty
On Thu, Nov 27, 2014 at 3:47 PM, Duncan Thomas wrote: > I'm not sure about making it mandatory, but I can certainly see the > benefits of doing this in some cases. Maybe we can start by creating the > area and making the doc optional, and allow reviews to ask for it to be > added where they consi

Re: [openstack-dev] [All] Proposal to add examples/usecase as part of new features / cli / functionality patches

2014-11-27 Thread Duncan Thomas
I'm not sure about making it mandatory, but I can certainly see the benefits of doing this in some cases. Maybe we can start by creating the area and making the doc optional, and allow reviews to ask for it to be added where they consider it useful? Sometimes (often in cinder), a feature gets writ

Re: [openstack-dev] [All] Proposal to add examples/usecase as part of new features / cli / functionality patches

2014-11-26 Thread Deepak Shetty
But isn't *-specs comes very early in the process where you have an idea/proposal of a feature, u don't have it yet implemented. Hence specs just end up with Para's on how the feature is supposed to work, but doesn't include any real world screen shots as the code is not yet ready at that point of

Re: [openstack-dev] [All] Proposal to add examples/usecase as part of new features / cli / functionality patches

2014-11-26 Thread Dolph Mathews
On Wed, Nov 26, 2014 at 1:15 PM, Steve Gordon wrote: > - Original Message - > > From: "Deepak Shetty" > > To: "OpenStack Development Mailing List (not for usage questions)" < > openstack-dev@lists.openstack.org> > > > > Hi stackers, > >I was having this thought which i believe applie

Re: [openstack-dev] [All] Proposal to add examples/usecase as part of new features / cli / functionality patches

2014-11-26 Thread Steve Gordon
- Original Message - > From: "Deepak Shetty" > To: "OpenStack Development Mailing List (not for usage questions)" > > > Hi stackers, >I was having this thought which i believe applies to all projects of > openstack (Hence All in the subject tag) > > My proposal is to have examples

Re: [openstack-dev] [All] Proposal to add examples/usecase as part of new features / cli / functionality patches

2014-11-26 Thread Deepak Shetty
Hi Valeriy, I know about docs, but this was a proposal to provide small doc which are patch specific as that helps reviewers and other doc writers I have many a times seen people asking on IRC or list on how to test this patch, or i did this with your patch but didn't work , such iterations can

Re: [openstack-dev] [All] Proposal to add examples/usecase as part of new features / cli / functionality patches

2014-11-26 Thread Valeriy Ponomaryov
Hi Deepak, Docs are present in any project already, according to example with manila - https://github.com/openstack/manila/tree/master/doc/source It is used for docs on http://docs.openstack.org/ , also everyone if able to contribute to it. See docs built on basis of files from manila repo: http

[openstack-dev] [All] Proposal to add examples/usecase as part of new features / cli / functionality patches

2014-11-25 Thread Deepak Shetty
Hi stackers, I was having this thought which i believe applies to all projects of openstack (Hence All in the subject tag) My proposal is to have examples or usecase folder in each project which has info on how to use the feature/enhancement (which was submitted as part of a gerrit patch) In sh