[openstack-dev] [nova] [docs] Scheduler filters documentation

Jay Pipes jaypipes at gmail.com
Thu Apr 30 01:00:13 UTC 2015

On 04/29/2015 03:41 PM, Ed Leafe wrote:
> On Apr 29, 2015, at 2:30 PM, Matt Riedemann
> <mriedem at linux.vnet.ibm.com> wrote:
>> I'd prefer to see the scheduler filter docs be maintained in the
>> nova devref where they are close to the source, versioned, and
>> reviewed by the nova team when there are scheduler filter changes
>> or new filters added.
> For now, I think this is best. When and if the scheduler is a
> separate entity, it will need its own docs; nova will still need to
> document *its* filters, but not *how to* filter.

So, the config-ref docs are auto-generated continually via automation 
scripts from the help text of options. And, IMO, this is A Good Thing.

In this case, the end user of this information is the cloud admin -- the 
person who creates flavors and tags compute nodes with capability extra 
specs. The target audience for this information is not really the Nova 

Now, if there are sections of the devref that need to inform the 
*developer* about some weird intricacies of the scheduler filters (and 
frankly, this is kind of one of them), then I think it's OK to have 
slightly duplicate information. It depends on the target audience. In 
this particular case, I think it's fine to duplicate a little.


More information about the OpenStack-dev mailing list