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

Matt Riedemann mriedem at linux.vnet.ibm.com
Wed Apr 29 19:30:42 UTC 2015



On 4/29/2015 2:08 PM, Sylvain Bauza wrote:
> A good comment has been provided to
> https://review.openstack.org/#/c/177824/1 by saying that the reference
> docs [1] are duplicate to the Nova devref section [2]
>
> As I also think it is error-prone to keep two separate informations
> about how Scheduler filters, I would like to discuss on how we could
> make sure both are in sync.
> Since the developers owe to provide how to use the filters they write,
> my preference goes to keep updating the Nova devref page each time a
> filter behaviour is changed or a new filter is created and consequently
> make sure that the reference docs is pointing to that devref page, using
> an iframe or whatever else.
>
> Of course, each time that a behavioural change is provided, that's also
> the developer's duty to provide a DocImpact tag in order to make sure
> that docs people are aware of the change.
>
> Thoughts ?
> -Sylvain
>
> [1]
> http://docs.openstack.org/juno/config-reference/content/section_compute-scheduler.html#aggregate-instanceextraspecsfilter
>
> [2]
> http://docs.openstack.org/developer/nova/devref/filter_scheduler.html#filtering
>
>
>
>
>
> __________________________________________________________________________
> OpenStack Development Mailing List (not for usage questions)
> Unsubscribe: OpenStack-dev-request at lists.openstack.org?subject:unsubscribe
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
>

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.

I doubt many nova developers/reviewers get over to reviewing changes to 
the config reference docs.

Then if possible have the config reference docs repo refer to the nova 
devref docs as the primary source of information on the filters.

-- 

Thanks,

Matt Riedemann




More information about the OpenStack-dev mailing list