<br>Thanks for sending this, <span dir="ltr">Masumotok</span>! I was planning to reach out to you to see what you had so far. I'll work with you to get the wiki page into RST and/or DocBook and will send you a separate email for the details. <br>
<br>Thanks,<br>Anne<br><br><br><div style="margin: 2em 0pt;" name="sig_d4a6b6619e"><div style="padding: 5px; font-size: 11px; color: rgb(102, 102, 102); font-family: sans-serif;">
<strong>Anne Gentle</strong>
<br>
<a href="mailto:anne@openstack.org" target="_blank">anne@openstack.org</a><br>
<div style="font-size: 10px;">
<a href="http://justwriteclick.com/" target="_blank">my blog</a> |
<a href="http://xmlpress.net/publications/conversation-community/" target="_blank">my book</a> |
<a href="http://www.linkedin.com/in/annegentle" target="_blank"><span>LinkedIn</span></a> | <a href="http://del.icio.us/annegentle" target="_blank">Delicious</a> |
<a href="http://twitter.com/annegentle" target="_blank">Twitter</a>
</div></div></div><div class="gmail_quote">On Tue, Feb 15, 2011 at 2:43 AM, <span dir="ltr"><<a href="mailto:masumotok@nttdata.co.jp">masumotok@nttdata.co.jp</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin: 0pt 0pt 0pt 0.8ex; border-left: 1px solid rgb(204, 204, 204); padding-left: 1ex;">
it is slightly out-of topic, but it might be good chance to say this, excuse me.. :)<br>
<div class="im"><br>
> For instance, when live-migrations goes in, I want to see some RST<br>
> documentation that explains the concepts involved to developers,<br>
> including how live migrations differs from, say, snapshotting.<br>
<br>
</div>For admins:<br>
<a href="http://wiki.openstack.org/LiveMigrationUsage" target="_blank">http://wiki.openstack.org/LiveMigrationUsage</a><br>
<br>
For Devs:<br>
Overall design document exists at :<br>
<<a href="http://wiki.openstack.org/LiveMigration?action=AttachFile&do=view&target=20110203cactus-migration-live.pdf" target="_blank">http://wiki.openstack.org/LiveMigration?action=AttachFile&do=view&target=20110203cactus-migration-live.pdf</a>><br>
<br>
Regarding to RST docs, I'm reading other rst docs to decide what to write.<br>
Please hold on..<br>
<div><div></div><div class="h5"><br>
-----Original Message-----<br>
From: openstack-bounces+masumotok=<a href="http://nttdata.co.jp" target="_blank">nttdata.co.jp</a>@<a href="http://lists.launchpad.net" target="_blank">lists.launchpad.net</a> [mailto:<a href="mailto:openstack-bounces%2Bmasumotok">openstack-bounces+masumotok</a>=<a href="http://nttdata.co.jp" target="_blank">nttdata.co.jp</a>@<a href="http://lists.launchpad.net" target="_blank">lists.launchpad.net</a>] On Behalf Of Jay Pipes<br>
Sent: Tuesday, February 15, 2011 12:29 AM<br>
To: Thierry Carrez<br>
Cc: <a href="mailto:openstack@lists.launchpad.net">openstack@lists.launchpad.net</a><br>
Subject: Re: [Openstack] documentation contributions<br>
<br>
On Mon, Feb 14, 2011 at 10:25 AM, Thierry Carrez <<a href="mailto:thierry@openstack.org">thierry@openstack.org</a>> wrote:<br>
> Jay Pipes wrote:<br>
>> IMHO, we should not be letting *any* significant new code into<br>
>> OpenStack projects without:<br>
>><br>
>> a) docstrings for all methods -- these turn into our API<br>
>> documentation, so they are critical<br>
><br>
> Agreed.<br>
><br>
>> b) Full RST docs for any new feature added. No exceptions.<br>
><br>
> One issue is that if you see the split in Anne's description, features<br>
> documentation needs to be added to the admin docs (Docbook), not really<br>
> the developer docs (RST), so it's in a separate branch. That makes it<br>
> harder to enforce...<br>
<br>
Sorry, I mean RST docs for concepts introduced by a feature patch.<br>
<br>
For instance, when live-migrations goes in, I want to see some RST<br>
documentation that explains the concepts involved to developers,<br>
including how live migrations differs from, say, snapshotting.<br>
<br>
For user and admin documentation, Anne can ready the concept RST docs<br>
in the developer documentation and work with the authors to produce<br>
user and admin-focused docbook manuals.<br>
<br>
my 2 cents and all that,<br>
-jay<br>
<br>
<br>
> IIUC the dev docs should contain docstrings and a few developer-oriented<br>
> info like "how to do i18n right" or "how we do logging in code" and<br>
> other "this is how we do it" topics. If we add features documentation,<br>
> that duplicates the work in the admin docs (Docbook) and increases user<br>
> confusion as to "where is *the* doc".<br>
><br>
> --<br>
> Thierry Carrez (ttx)<br>
> Release Manager, OpenStack<br>
><br>
> _______________________________________________<br>
> Mailing list: <a href="https://launchpad.net/%7Eopenstack" target="_blank">https://launchpad.net/~openstack</a><br>
> Post to : <a href="mailto:openstack@lists.launchpad.net">openstack@lists.launchpad.net</a><br>
> Unsubscribe : <a href="https://launchpad.net/%7Eopenstack" target="_blank">https://launchpad.net/~openstack</a><br>
> More help : <a href="https://help.launchpad.net/ListHelp" target="_blank">https://help.launchpad.net/ListHelp</a><br>
><br>
<br>
_______________________________________________<br>
Mailing list: <a href="https://launchpad.net/%7Eopenstack" target="_blank">https://launchpad.net/~openstack</a><br>
Post to : <a href="mailto:openstack@lists.launchpad.net">openstack@lists.launchpad.net</a><br>
Unsubscribe : <a href="https://launchpad.net/%7Eopenstack" target="_blank">https://launchpad.net/~openstack</a><br>
More help : <a href="https://help.launchpad.net/ListHelp" target="_blank">https://help.launchpad.net/ListHelp</a><br>
_______________________________________________<br>
Mailing list: <a href="https://launchpad.net/%7Eopenstack" target="_blank">https://launchpad.net/~openstack</a><br>
Post to : <a href="mailto:openstack@lists.launchpad.net">openstack@lists.launchpad.net</a><br>
Unsubscribe : <a href="https://launchpad.net/%7Eopenstack" target="_blank">https://launchpad.net/~openstack</a><br>
More help : <a href="https://help.launchpad.net/ListHelp" target="_blank">https://help.launchpad.net/ListHelp</a><br>
</div></div></blockquote></div><br>