[openstack-dev] [Fuel] Improvement of the blueprint specs template

[Roman Prykhodchenko]

Hi folks!

I was reviewing one of specs for Fuel 7.0 and realized the information there is 
messed up and it’s pretty hard to put it all together. The reason for that is 
basically that Fuel is a multicomponent project but the template does not 
consider that — there is a Proposed change section which is used to define all 
the changes in the entire project; then there is the API and Data impact 
sections that are specific to only specific components but still have to be 
filled in.

Since most of new features consider changes to several components I propose to 
stick to the following structure. It eliminates the need to create several 
specs to describe one feature and allows to organize everything in one document 
without messing it up:

--> Title
--> Excerpt (short version of the Problem description, proposed solution and 
final results)
--> Problem description
--> Proposed changes
--> Web UI
--> Nailgun
--> General
--> REST API
--> Data model
--> Astute
--> General
--> RPC protocol
--> Fuel Client
--> Plugins
--> Impact
--> End-user
--> QA
--> Developer
--> Infrastructure (operations)
--> Upgrade
--> Performance
--> Implementation
--> Assignee
--> Work items
--> Web UI
--> Nailgun
--> Astute
--> Fuel Client
--> Plugins
--> Documentation
--> References


- romcheg





signature.asc
Description: Message signed with OpenPGP using GPGMail
__
OpenStack Development Mailing List (not for usage questions)
Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev

Re: [openstack-dev] [Fuel] Improvement of the blueprint specs template

[Roman Prykhodchenko]

I realize, that discussing this topic in the email is hard. I filed a review 
request with some changes to the template and invite you folks to take a look 
at that: https://review.openstack.org/193070 



> 16 черв. 2015 о 17:08 Roman Prykhodchenko  написав(ла):
> 
> Hi folks!
> 
> I was reviewing one of specs for Fuel 7.0 and realized the information there 
> is messed up and it’s pretty hard to put it all together. The reason for that 
> is basically that Fuel is a multicomponent project but the template does not 
> consider that — there is a Proposed change section which is used to define 
> all the changes in the entire project; then there is the API and Data impact 
> sections that are specific to only specific components but still have to be 
> filled in.
> 
> Since most of new features consider changes to several components I propose 
> to stick to the following structure. It eliminates the need to create several 
> specs to describe one feature and allows to organize everything in one 
> document without messing it up:
> 
> --> Title
> --> Excerpt (short version of the Problem description, proposed solution and 
> final results)
> --> Problem description
> --> Proposed changes
> --> Web UI
> --> Nailgun
> --> General
> --> REST API
> --> Data model
> --> Astute
> --> General
> --> RPC protocol
> --> Fuel Client
> --> Plugins
> --> Impact
> --> End-user
> --> QA
> --> Developer
> --> Infrastructure (operations)
> --> Upgrade
> --> Performance
> --> Implementation
> --> Assignee
> --> Work items
> --> Web UI
> --> Nailgun
> --> Astute
> --> Fuel Client
> --> Plugins
> --> Documentation
> --> References
> 
> 
> - romcheg
> 
> 
> 
> __
> OpenStack Development Mailing List (not for usage questions)
> Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev



signature.asc
Description: Message signed with OpenPGP using GPGMail
__
OpenStack Development Mailing List (not for usage questions)
Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev

Re: [openstack-dev] [Fuel] Improvement of the blueprint specs template

[Roman Prykhodchenko]

Guys,

I’d like to ask all Fuel component leads to take a look at the proposed changes 
and check whether all important sections were added.


- romcheg
> 18 черв. 2015 о 13:14 Roman Prykhodchenko  написав(ла):
> 
> I realize, that discussing this topic in the email is hard. I filed a review 
> request with some changes to the template and invite you folks to take a look 
> at that: https://review.openstack.org/193070 
> 
> 
> 
>> 16 черв. 2015 о 17:08 Roman Prykhodchenko > > написав(ла):
>> 
>> Hi folks!
>> 
>> I was reviewing one of specs for Fuel 7.0 and realized the information there 
>> is messed up and it’s pretty hard to put it all together. The reason for 
>> that is basically that Fuel is a multicomponent project but the template 
>> does not consider that — there is a Proposed change section which is used to 
>> define all the changes in the entire project; then there is the API and Data 
>> impact sections that are specific to only specific components but still have 
>> to be filled in.
>> 
>> Since most of new features consider changes to several components I propose 
>> to stick to the following structure. It eliminates the need to create 
>> several specs to describe one feature and allows to organize everything in 
>> one document without messing it up:
>> 
>> --> Title
>> --> Excerpt (short version of the Problem description, proposed solution and 
>> final results)
>> --> Problem description
>> --> Proposed changes
>> --> Web UI
>> --> Nailgun
>> --> General
>> --> REST API
>> --> Data model
>> --> Astute
>> --> General
>> --> RPC protocol
>> --> Fuel Client
>> --> Plugins
>> --> Impact
>> --> End-user
>> --> QA
>> --> Developer
>> --> Infrastructure (operations)
>> --> Upgrade
>> --> Performance
>> --> Implementation
>> --> Assignee
>> --> Work items
>> --> Web UI
>> --> Nailgun
>> --> Astute
>> --> Fuel Client
>> --> Plugins
>> --> Documentation
>> --> References
>> 
>> 
>> - romcheg
>> 
>> 
>> 
>> __
>> OpenStack Development Mailing List (not for usage questions)
>> Unsubscribe: openstack-dev-requ...@lists.openstack.org 
>> ?subject:unsubscribe
>> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev 
>> 
> 
> __
> OpenStack Development Mailing List (not for usage questions)
> Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev



signature.asc
Description: Message signed with OpenPGP using GPGMail
__
OpenStack Development Mailing List (not for usage questions)
Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev