<div dir="ltr"><br><div class="gmail_extra"><br><br><div class="gmail_quote">On Tue, Apr 23, 2013 at 1:20 PM, Neal, Phil (Cloud Services) <span dir="ltr"><<a href="mailto:phil.neal@hp.com" target="_blank">phil.neal@hp.com</a>></span> wrote:<br>
<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">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 exist, so<br>
I'm hoping that someone can shed some light on the process or point me to<br>
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, just<br>
need confirmation.<br></blockquote><div><br></div><div style>Yes. Ceilometer has just become integrated, and before then we were maintaining our own docs. Now we are going to be working with the docs team to integrate with the other manuals. In the mean time, we agreed to continue adding docs to the existing source files so we could merge it all at one time, when ready.</div>
<div> </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 html"<br>
command to generate the html files. I'm running into a host of errors,<br>
though, so I'm questioning if this is the right tool.<br></blockquote><div><br></div><div style>You'll need a system with ceilometer and its dependencies installed, and then you should run "python setup.py build_sphinx" to make sure all of the auto-generated files are created.</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 content<br>
that's getting generated that doesn't exist in the code or the .rst<br>
files....is it black magic?<br></blockquote><div><br></div><div style>There are some auto-doc directives used to pull text in from the documentation embedded in the source code. That's especially the case for the web API documentation. You shouldn't need to worry about any of that for the changes you want, except that you need to be able to install ceilometer in order for it to work.</div>
<div style><br></div><div style>Doug</div><div> </div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
<span class="HOEnZb"><font color="#888888"><br>
- Phil<br>
<br>
</font></span><br>_______________________________________________<br>
OpenStack-dev mailing list<br>
<a href="mailto: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>
<br></blockquote></div><br></div></div>