<html xmlns:v="urn:schemas-microsoft-com:vml" xmlns:o="urn:schemas-microsoft-com:office:office" xmlns:w="urn:schemas-microsoft-com:office:word" xmlns:m="http://schemas.microsoft.com/office/2004/12/omml" xmlns="http://www.w3.org/TR/REC-html40"><head><meta http-equiv=Content-Type content="text/html; charset=iso-2022-jp"><meta name=Generator content="Microsoft Word 12 (filtered medium)"><style><!--
/* Font Definitions */
@font-face
        {font-family:"$B#M#S(B $B%4%7%C%/(B";
        panose-1:2 11 6 9 7 2 5 8 2 4;}
@font-face
        {font-family:"Cambria Math";
        panose-1:2 4 5 3 5 4 6 3 2 4;}
@font-face
        {font-family:"$B#M#S(B $B#P%4%7%C%/(B";
        panose-1:2 11 6 0 7 2 5 8 2 4;}
@font-face
        {font-family:Tahoma;
        panose-1:2 11 6 4 3 5 4 4 2 4;}
@font-face
        {font-family:"\@$B#M#S(B $B%4%7%C%/(B";
        panose-1:2 11 6 9 7 2 5 8 2 4;}
@font-face
        {font-family:"\@$B#M#S(B $B#P%4%7%C%/(B";
        panose-1:2 11 6 0 7 2 5 8 2 4;}
/* Style Definitions */
p.MsoNormal, li.MsoNormal, div.MsoNormal
        {margin:0mm;
        margin-bottom:.0001pt;
        font-size:12.0pt;
        font-family:"$B#M#S(B $B#P%4%7%C%/(B";}
a:link, span.MsoHyperlink
        {mso-style-priority:99;
        color:blue;
        text-decoration:underline;}
a:visited, span.MsoHyperlinkFollowed
        {mso-style-priority:99;
        color:purple;
        text-decoration:underline;}
span.18
        {mso-style-type:personal-reply;
        font-family:"Arial","sans-serif";
        color:#1F497D;}
.MsoChpDefault
        {mso-style-type:export-only;}
@page WordSection1
        {size:612.0pt 792.0pt;
        margin:99.25pt 30.0mm 30.0mm 30.0mm;}
div.WordSection1
        {page:WordSection1;}
--></style><!--[if gte mso 9]><xml>
<o:shapedefaults v:ext="edit" spidmax="1026">
<v:textbox inset="5.85pt,.7pt,5.85pt,.7pt" />
</o:shapedefaults></xml><![endif]--><!--[if gte mso 9]><xml>
<o:shapelayout v:ext="edit">
<o:idmap v:ext="edit" data="1" />
</o:shapelayout></xml><![endif]--></head><body lang=JA link=blue vlink=purple><div class=WordSection1><p class=MsoNormal><span lang=EN-US style='font-size:10.0pt;font-family:"Arial","sans-serif";color:#1F497D'>I appreciate your help.<o:p></o:p></span></p><p class=MsoNormal><span lang=EN-US style='font-size:10.0pt;font-family:"Arial","sans-serif";color:#1F497D'>I$B!G(Bm looking forward to the details you notice me$B!D(B<o:p></o:p></span></p><p class=MsoNormal><span lang=EN-US style='font-size:10.0pt;font-family:"Arial","sans-serif";color:#1F497D'><o:p> </o:p></span></p><p class=MsoNormal><span lang=EN-US style='font-size:10.0pt;font-family:"Arial","sans-serif";color:#1F497D'>Thanks.<o:p></o:p></span></p><p class=MsoNormal><span lang=EN-US style='font-size:10.0pt;font-family:"Arial","sans-serif";color:#1F497D'>Kei<o:p></o:p></span></p><p class=MsoNormal><span lang=EN-US style='font-size:10.0pt;font-family:"Arial","sans-serif";color:#1F497D'><o:p> </o:p></span></p><div style='border:none;border-top:solid #B5C4DF 1.0pt;padding:3.0pt 0mm 0mm 0mm'><p class=MsoNormal><b><span lang=EN-US style='font-size:10.0pt;font-family:"Tahoma","sans-serif"'>From:</span></b><span lang=EN-US style='font-size:10.0pt;font-family:"Tahoma","sans-serif"'> annegentle@justwriteclick.com [mailto:annegentle@justwriteclick.com] <b>On Behalf Of </b>Anne Gentle<br><b>Sent:</b> Wednesday, February 16, 2011 3:33 AM<br><b>To:</b> RDH </span><span style='font-size:10.0pt'>$BKqK\(B</span><span style='font-size:10.0pt;font-family:"Tahoma","sans-serif"'> </span><span style='font-size:10.0pt'>$B7=(B</span><span lang=EN-US style='font-size:10.0pt;font-family:"Tahoma","sans-serif"'>(</span><span style='font-size:10.0pt'>$B#I#T%"!<%-!u%;%-%e5;=Q(B</span><span lang=EN-US style='font-size:10.0pt;font-family:"Tahoma","sans-serif"'>)<br><b>Cc:</b> jaypipes@gmail.com; thierry@openstack.org; openstack@lists.launchpad.net<br><b>Subject:</b> Re: [Openstack] documentation contributions<o:p></o:p></span></p></div><p class=MsoNormal><span lang=EN-US><o:p> </o:p></span></p><p class=MsoNormal style='margin-bottom:12.0pt'><span lang=EN-US><br>Thanks for sending this, Masumotok! 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><o:p></o:p></span></p><div style='margin-top:24.0pt;margin-bottom:24.0pt' name="sig_d4a6b6619e"><div><p class=MsoNormal><strong><span lang=EN-US style='font-size:8.5pt;font-family:"Arial","sans-serif";color:#666666'>Anne Gentle</span></strong><span lang=EN-US style='font-size:8.5pt;font-family:"Arial","sans-serif";color:#666666'> <br><a href="mailto:anne@openstack.org" target="_blank">anne@openstack.org</a><o:p></o:p></span></p><div><p class=MsoNormal><span lang=EN-US style='font-size:7.5pt;font-family:"Arial","sans-serif";color:#666666'><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">LinkedIn</a> | <a href="http://del.icio.us/annegentle" target="_blank">Delicious</a> | <a href="http://twitter.com/annegentle" target="_blank">Twitter</a> <o:p></o:p></span></p></div></div></div><div><p class=MsoNormal><span lang=EN-US>On Tue, Feb 15, 2011 at 2:43 AM, <<a href="mailto:masumotok@nttdata.co.jp">masumotok@nttdata.co.jp</a>> wrote:<o:p></o:p></span></p><p class=MsoNormal><span lang=EN-US>it is slightly out-of topic, but it might be good chance to say this, excuse me.. :)<o:p></o:p></span></p><div><p class=MsoNormal style='margin-bottom:12.0pt'><span lang=EN-US><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.<o:p></o:p></span></p></div><p class=MsoNormal><span lang=EN-US>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..<o:p></o:p></span></p><div><div><p class=MsoNormal><span lang=EN-US><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><o:p></o:p></span></p></div></div></div><p class=MsoNormal><span lang=EN-US><o:p> </o:p></span></p></div></body></html>