<br><br>On Wednesday, April 24, 2013, Neal, Phil (Cloud Services) wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><br>
> On Tue, Apr 23, 2013 at 1:20 PM, Neal, Phil (Cloud Services)<br>
> <<a href="javascript:;" onclick="_e(event, 'cvml', 'phil.neal@hp.com')">phil.neal@hp.com</a>> wrote:<br>
><br>
><br>
> > The documentation on how to make updates to the content at<br>
> > <a href="http://docs.openstack.org/developer/ceilometer/." target="_blank">http://docs.openstack.org/developer/ceilometer/.</a>.. doesn't seem to<br>
> > exist, so I'm hoping that someone can shed some light on the process<br>
>> or point me to the right spot...<br>
> ><br>
> > Here's what I'm running into:<br>
> ><br>
> > 1. It looks like we're maintaining documentation in our Ceilometer repo<br>
> > (<a href="https://github.com/openstack/ceilometer" target="_blank">https://github.com/openstack/ceilometer</a> vs. the centralized set at<br>
>> <a href="https://github.com/openstack/openstack-manuals.git" target="_blank">https://github.com/openstack/openstack-manuals.git</a>). No problems there,<br>
>> just need confirmation.<br>
><br>
> Yes. Ceilometer has just become integrated, and before then we were<br>
> maintaining our own docs. Now we are going to be working with the docs<br>
> team to integrate with the other manuals. In the mean time, we agreed to<br>
> continue adding docs to the existing source files so we could merge it all at<br>
> one time, when ready.<br>
<br>
Makes sense. I'm betting the release/update process will change when that happens?</blockquote><div><br></div><br><div> For the docs that move into the repo managed by the doc team, yes. The developer docs will stay where they are. </div>
<div><br></div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
><br>
>> 2. It seems like the correct approach is to make edits as needed to the<br>
> > content ceilometer/docs/source directory, then run the Sphinx "make<br>
> > html" command to generate the html files. I'm running into a host of<br>
> > errors, though, so I'm questioning if this is the right tool.<br>
><br>
<br>
> You'll need a system with ceilometer and its dependencies installed, and<br>
> then you should run "python setup.py build_sphinx" to make sure all of the<br>
> auto-generated files are created.<br>
<br>
FWIW, the quickest way to install the dependencies (short of a full Devstack deployment) seems to be by running pip install against the test-requires file. I was able to run both build_sphinx and the Sphinx command "make html".</blockquote>
<div><br></div><div>That sounds about right. </div><div><br></div><div> </div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
><br>
> > 3. I'm not understanding the connection between the content of the .rst<br>
> > files and what appears on the web site...it seems like there's some<br>
> > content that's getting generated that doesn't exist in the code or the<br>
>> .rst files....is it black magic?<br>
><br>
> There are some auto-doc directives used to pull text in from the<br>
> documentation embedded in the source code. That's especially the case for<br>
> the web API documentation. You shouldn't need to worry about any of that<br>
> for the changes you want, except that you need to be able to install<br>
> ceilometer in order for it to work.<br>
<br>
Agreed, I just skipped past that to add reST-formatted text in the appropriate spots. No need to become an expert at this point. :-)<br>
<br>
><br>
> Doug<br>
><br>
><br>
<br>
Tremendously helpful...thanks again.</blockquote><div><br></div><div>Thanks for working on the docs!</div><div><br></div><div>Doug<span></span></div><div> </div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
<br>
- Phil<br>
<br>
_______________________________________________<br>
OpenStack-dev mailing list<br>
<a href="javascript:;" onclick="_e(event, 'cvml', 'OpenStack-dev@lists.openstack.org')">OpenStack-dev@lists.openstack.org</a><br>
<a href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev" target="_blank">http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev</a><br>
</blockquote>