Re: [openstack-dev] [docs] Can we get the "configuration reference" of master more often?

[Ronald Bradford]

On Thu, Mar 3, 2016 at 9:51 AM, Andreas Jaeger  wrote:

> On 2016-03-03 15:37, Markus Zoeller wrote:
> > The "configuration reference" manual at [1] is really helpful to get
> > an overview of the options and we (Nova folks) were wondering if we
> > could have that updated more often [2].
> >
> > Right now it is from November 2015 [3] and we (Nova folks) put a lot of
> > effort this cycle in improving the help of our config options but they
> > aren't yet (fully) reflected in that guide.
> >
>

>From what little I have read, this Nova work is around consolidation and
grouping of existing options, and not the addition of new options?
The nova.flagmappings files [5] defines a relationship of the displayed
table of options (the heading in the nova.headers file) and the options.
The group information can be specified as a prefix to the option,
e.g. database/backend database.

the "Description of conductor configuration options" table for example in
[1] (sorry no direct linking possible, feature perhaps?) , where a table
may contain options from multiple groups or namespaces.


> > Different options would be:
> > A: per milestone
> > B: per merge of a commit which contains "DocImpact" in its message
> > C: daily/nightly
> >
> > Personally I think daily/nightly would be sufficient.
> >
> > AFAIK the generation of that guide is done with [4] and IIUC there is
> > no necessity of human intervention in that process, or did I miss
> > something?
>

I have been looking into this process at present in free time to understand
and see how docs are generated. From my discussion with Gauvain it is both
manual and time consuming.


>
> The flagmappings file is manually updated - if a new option shows up, we
> need to know to which table it should be added. Doug and Gauvain
>

table or tables.  There is a 1 to n mapping of option to table, expressed
as one line in the file. The nova file has no example, cinder is a place to
look at.



> discussed automating this in the future but this needs first some changes,
>


[5]
http://git.openstack.org/cgit/openstack/openstack-manuals/tree/tools/autogenerate-config-flagmappings/nova.flagmappings
__
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] [docs] Can we get the "configuration reference" of master more often?

[Andreas Jaeger]

On 2016-03-03 15:37, Markus Zoeller wrote:
> The "configuration reference" manual at [1] is really helpful to get
> an overview of the options and we (Nova folks) were wondering if we 
> could have that updated more often [2]. 
> 
> Right now it is from November 2015 [3] and we (Nova folks) put a lot of 
> effort this cycle in improving the help of our config options but they 
> aren't yet (fully) reflected in that guide.
> 
> Different options would be:
> A: per milestone
> B: per merge of a commit which contains "DocImpact" in its message
> C: daily/nightly
> 
> Personally I think daily/nightly would be sufficient.
> 
> AFAIK the generation of that guide is done with [4] and IIUC there is
> no necessity of human intervention in that process, or did I miss
> something?

The flagmappings file is manually updated - if a new option shows up, we
need to know to which table it should be added. Doug and Gauvain
discussed automating this in the future but this needs first some changes,

Andreas

> 
> References:
> [1] 
> http://docs.openstack.org/draft/config-reference/compute/config-options.html
> [2] 
> http://eavesdrop.openstack.org/irclogs/%23openstack-nova/%23openstack-nova.2016-03-03.log.html#t2016-03-03T13:40:15
> [3] 
> http://eavesdrop.openstack.org/irclogs/%23openstack-doc/%23openstack-doc.2016-03-03.log.html#t2016-03-03T13:51:15
> [4] 
> https://github.com/openstack/openstack-doc-tools/tree/master/autogenerate_config_docs
> 
> Regards, Markus Zoeller (markus_z)
> 
> 
> __
> 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
> 


-- 
 Andreas Jaeger aj@{suse.com,opensuse.org} Twitter: jaegerandi
  SUSE LINUX GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany
   GF: Felix Imendörffer, Jane Smithard, Graham Norton,
   HRB 21284 (AG Nürnberg)
GPG fingerprint = 93A3 365E CE47 B889 DF7F FED1 389A 563C C272 A126


__
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] [docs] Can we get the "configuration reference" of master more often?

[Anne Gentle]

On Thu, Mar 3, 2016 at 8:37 AM, Markus Zoeller  wrote:

> The "configuration reference" manual at [1] is really helpful to get
> an overview of the options and we (Nova folks) were wondering if we
> could have that updated more often [2].
>
> Right now it is from November 2015 [3] and we (Nova folks) put a lot of
> effort this cycle in improving the help of our config options but they
> aren't yet (fully) reflected in that guide.
>
> Different options would be:
> A: per milestone
> B: per merge of a commit which contains "DocImpact" in its message
> C: daily/nightly
>
> Personally I think daily/nightly would be sufficient.
>
> AFAIK the generation of that guide is done with [4] and IIUC there is
> no necessity of human intervention in that process, or did I miss
> something?
>

Yes. The necessity of a human running that tool and creating a patch.

Would love help automating, of course!

Thanks,
Anne


>
> References:
> [1]
>
> http://docs.openstack.org/draft/config-reference/compute/config-options.html
> [2]
>
> http://eavesdrop.openstack.org/irclogs/%23openstack-nova/%23openstack-nova.2016-03-03.log.html#t2016-03-03T13:40:15
> [3]
>
> http://eavesdrop.openstack.org/irclogs/%23openstack-doc/%23openstack-doc.2016-03-03.log.html#t2016-03-03T13:51:15
> [4]
>
> https://github.com/openstack/openstack-doc-tools/tree/master/autogenerate_config_docs
>
> Regards, Markus Zoeller (markus_z)
>
>
> __
> 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
>



-- 
Anne Gentle
Rackspace
Principal Engineer
www.justwriteclick.com
__
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-dev] [docs] Can we get the "configuration reference" of master more often?

[Markus Zoeller]

The "configuration reference" manual at [1] is really helpful to get
an overview of the options and we (Nova folks) were wondering if we 
could have that updated more often [2]. 

Right now it is from November 2015 [3] and we (Nova folks) put a lot of 
effort this cycle in improving the help of our config options but they 
aren't yet (fully) reflected in that guide.

Different options would be:
A: per milestone
B: per merge of a commit which contains "DocImpact" in its message
C: daily/nightly

Personally I think daily/nightly would be sufficient.

AFAIK the generation of that guide is done with [4] and IIUC there is
no necessity of human intervention in that process, or did I miss
something?

References:
[1] 
http://docs.openstack.org/draft/config-reference/compute/config-options.html
[2] 
http://eavesdrop.openstack.org/irclogs/%23openstack-nova/%23openstack-nova.2016-03-03.log.html#t2016-03-03T13:40:15
[3] 
http://eavesdrop.openstack.org/irclogs/%23openstack-doc/%23openstack-doc.2016-03-03.log.html#t2016-03-03T13:51:15
[4] 
https://github.com/openstack/openstack-doc-tools/tree/master/autogenerate_config_docs

Regards, Markus Zoeller (markus_z)


__
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