<html><body><div style="color:#000; background-color:#fff; font-family:HelveticaNeue, Helvetica Neue, Helvetica, Arial, Lucida Grande, sans-serif;font-size:12px"><div dir="ltr" id="yui_3_16_0_1_1428343731379_88919"><span id="yui_3_16_0_1_1428343731379_88954">Why can't we use the standard Sphinx xref tools for links to this frequently-used information?</span></div><div id="yui_3_16_0_1_1428343731379_88979" dir="ltr"><br><span id="yui_3_16_0_1_1428343731379_88954"></span></div><div id="yui_3_16_0_1_1428343731379_88984" dir="ltr"><span id="yui_3_16_0_1_1428343731379_88954"><a id="yui_3_16_0_1_1428343731379_88983" href="http://sphinx-doc.org/markup/inline.html">http://sphinx-doc.org/markup/inline.html<br></a></span></div><div id="yui_3_16_0_1_1428343731379_89030"> <br></div><div dir="ltr" id="yui_3_16_0_1_1428343731379_89031">It's pretty easy for docs in the same repo. I've heard that there is a way to implement this for</div><div id="yui_3_16_0_1_1428343731379_89142" dir="ltr">docs in different repos but I don't have experience with that.<br></div><div id="yui_3_16_0_1_1428343731379_89115" dir="ltr"><br></div><div id="yui_3_16_0_1_1428343731379_89144" dir="ltr">meg</div><div id="yui_3_16_0_1_1428343731379_89113" dir="ltr"><br></div><blockquote id="yui_3_16_0_1_1428343731379_88925" style="border-left: 2px solid rgb(16, 16, 255); margin-left: 5px; margin-top: 5px; padding-left: 5px;"> <div id="yui_3_16_0_1_1428343731379_88924" style="font-family: HelveticaNeue, Helvetica Neue, Helvetica, Arial, Lucida Grande, sans-serif; font-size: 12px;"> <div id="yui_3_16_0_1_1428343731379_88923" style="font-family: HelveticaNeue, Helvetica Neue, Helvetica, Arial, Lucida Grande, sans-serif; font-size: 16px;"> <div id="yui_3_16_0_1_1428343731379_88922" dir="ltr"> <hr id="yui_3_16_0_1_1428343731379_88921" size="1"> <font id="yui_3_16_0_1_1428343731379_89028" face="Arial" size="2"> <b id="yui_3_16_0_1_1428343731379_89146"><span id="yui_3_16_0_1_1428343731379_89145" style="font-weight:bold;">From:</span></b> Anne Gentle <annegentle@justwriteclick.com><br> <b><span style="font-weight: bold;">To:</span></b> Karen Bradshaw <kbhawkey@gmail.com> <br><b><span style="font-weight: bold;">Cc:</span></b> Andreas Jaeger <aj@suse.com>; "openstack-docs@lists.openstack.org" <openstack-docs@lists.openstack.org> <br> <b><span style="font-weight: bold;">Sent:</span></b> Monday, April 6, 2015 8:36 AM<br> <b id="yui_3_16_0_1_1428343731379_89149"><span id="yui_3_16_0_1_1428343731379_89148" style="font-weight: bold;">Subject:</span></b> Re: [OpenStack-docs] tables, figures, appendix A<br> </font> </div> <div id="yui_3_16_0_1_1428343731379_89026" class="y_msg_container"><br><div id="yiv2842901328"><div id="yui_3_16_0_1_1428343731379_89067"><div id="yui_3_16_0_1_1428343731379_89066" dir="ltr"><br clear="none"><div id="yui_3_16_0_1_1428343731379_89089" class="yiv2842901328gmail_extra"><br clear="none"><div id="yui_3_16_0_1_1428343731379_89091" class="yiv2842901328gmail_quote">On Mon, Apr 6, 2015 at 10:28 AM, Karen Bradshaw <span dir="ltr"><<a rel="nofollow" shape="rect" ymailto="mailto:kbhawkey@gmail.com" target="_blank" href="mailto:kbhawkey@gmail.com">kbhawkey@gmail.com</a>></span> wrote:<br clear="none"><blockquote id="yui_3_16_0_1_1428343731379_89094" class="yiv2842901328gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex;"><div id="yui_3_16_0_1_1428343731379_89093" dir="ltr">Hi. I do not have an opinion about including the tables and figures.<div id="yui_3_16_0_1_1428343731379_89096">Just checking on what should be included or not.</div></div></blockquote><div id="yui_3_16_0_1_1428343731379_89098"><br clear="none"></div><div id="yui_3_16_0_1_1428343731379_89100">So far we are reviewing with a convention that we don't have captions on figures or labels on tables. (Ha! That rhymes.) Let's stick with that convention.</div><div id="yui_3_16_0_1_1428343731379_89102"> </div><blockquote id="yui_3_16_0_1_1428343731379_89106" class="yiv2842901328gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex;"><div id="yui_3_16_0_1_1428343731379_89105" dir="ltr"><div id="yui_3_16_0_1_1428343731379_89104">The links provide another navigation point into the documentation.</div><div>For information that is used frequently, say a common installation routine or </div><div>API commands, a link may be useful.</div></div></blockquote><div><br clear="none"></div><div>Agreed, but I don't know how to make those with Sphinx right now, so at this point in the migration we won't plan on doing those.</div><div> </div><blockquote class="yiv2842901328gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex;"><div dir="ltr"><div>I can try and do the initial conversion of app_support.xml to user-guides/source/common/app_support.rst? Where would this file be included, under indices and tables in index.rst and index-admin.rst?</div></div></blockquote><div><br clear="none"></div><div>Yep, you got it!</div><div><br clear="none"></div><div>Anne</div><div> </div><blockquote class="yiv2842901328gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex;"><div dir="ltr"><span class="yiv2842901328HOEnZb"><font color="#888888"></font></span><div>-Karen</div></div><div class="yiv2842901328HOEnZb"><div class="yiv2842901328h5"><div class="yiv2842901328gmail_extra"><br clear="none"><div class="yiv2842901328gmail_quote">On Mon, Apr 6, 2015 at 10:54 AM, Anne Gentle <span dir="ltr"><<a rel="nofollow" shape="rect" ymailto="mailto:annegentle@justwriteclick.com" target="_blank" href="mailto:annegentle@justwriteclick.com">annegentle@justwriteclick.com</a>></span> wrote:<br clear="none"><blockquote class="yiv2842901328gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex;"><div dir="ltr"><br clear="none"><div class="yiv2842901328gmail_extra"><br clear="none"><div class="yiv2842901328gmail_quote"><span>On Mon, Apr 6, 2015 at 9:48 AM, Andreas Jaeger <span dir="ltr"><<a rel="nofollow" shape="rect" ymailto="mailto:aj@suse.com" target="_blank" href="mailto:aj@suse.com">aj@suse.com</a>></span> wrote:<br clear="none"></span><blockquote class="yiv2842901328gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-color:rgb(204,204,204);border-left-style:solid;padding-left:1ex;"><span>On 04/06/2015 03:38 PM, Karen Bradshaw wrote:<br clear="none">
</span><blockquote class="yiv2842901328gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-color:rgb(204,204,204);border-left-style:solid;padding-left:1ex;">
Hi. I am reviewing the new content generated for the admin user guide.<br clear="none">
</blockquote>
<br clear="none">
thanks!<span><br clear="none">
<br clear="none">
</span><blockquote class="yiv2842901328gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-color:rgb(204,204,204);border-left-style:solid;padding-left:1ex;">
Is there a plan to add an appendix for community support information?<br clear="none">
</blockquote>
<br clear="none">
IMHO it would be great to have it. Do you want to convert it?</blockquote><div><br clear="none"></div><div>Please do add it. If you can't convert it, just let me know and I'll do it.</div><span></span><div> </div><blockquote class="yiv2842901328gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-color:rgb(204,204,204);border-left-style:solid;padding-left:1ex;"><span><br clear="none">
<br clear="none">
</span><blockquote class="yiv2842901328gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-color:rgb(204,204,204);border-left-style:solid;padding-left:1ex;">
How about adding labels for the tables and figures?<br clear="none">
</blockquote>
<br clear="none">
If we do this, let's write it down on our markup conventions page as well. I'm not feeling strongly either right now,<br clear="none"></blockquote><div><br clear="none"></div><div><br clear="none"></div><div>Currently our convention for RST markup is to only use the image directive. We'd have to start using the figure directive in order to get a caption for each figure. </div><div><br clear="none"></div><div><a rel="nofollow" shape="rect" target="_blank" href="https://wiki.openstack.org/wiki/Documentation/Markup_conventions#Image">https://wiki.openstack.org/wiki/Documentation/Markup_conventions#Image</a> is where the convention is documented. <br clear="none"></div><div><br clear="none"></div><div>For tables, I'm not aware of a way to ensure a caption is used, other than to put it in our conventions as a paragraph before the table. </div><div><br clear="none"></div><div>With the migration goal of simplifying and welcoming more contributors, it seems a little heavy-handed to require captions for tables and figures. So I want to hear why we would require them other than "we've done it that way before." Any thoughts? I can't justify the overhead when we aren't doing collections of them in the new world. Any other thoughts? </div><div><br clear="none"></div><div>Thanks,</div><div>Anne</div><div> </div><blockquote class="yiv2842901328gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-color:rgb(204,204,204);border-left-style:solid;padding-left:1ex;">
<br clear="none">
Andreas<span><font color="#888888"><span><br clear="none">
-- <br clear="none">
Andreas Jaeger aj@{<a rel="nofollow" shape="rect" target="_blank" href="http://suse.com/">suse.com</a>,<a rel="nofollow" shape="rect" target="_blank" href="http://opensuse.org/">opensuse.org</a>} Twitter/Identica: jaegerandi<br clear="none">
SUSE LINUX GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany<br clear="none">
GF: Felix Imendörffer, Jane Smithard, Jennifer Guild, Dilip Upmanyu,<br clear="none">
Graham Norton, HRB 21284 (AG Nürnberg)<br clear="none">
GPG fingerprint = 93A3 365E CE47 B889 DF7F FED1 389A 563C C272 A126<br clear="none">
<br clear="none">
<br clear="none"></span>
______________________________<u></u>_________________<br clear="none">
OpenStack-docs mailing list<br clear="none">
<a rel="nofollow" shape="rect" ymailto="mailto:OpenStack-docs@lists.openstack.org" target="_blank" href="mailto:OpenStack-docs@lists.openstack.org">OpenStack-docs@lists.<u></u>openstack.org</a><br clear="none">
<a rel="nofollow" shape="rect" target="_blank" href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs">http://lists.openstack.org/<u></u>cgi-bin/mailman/listinfo/<u></u>openstack-docs</a><span><font color="#888888"><div class="qtdSeparateBR"><br><br></div><div class="yiv2842901328yqt1677460141" id="yiv2842901328yqtfd59338"><br clear="none">
</div></font></span></font></span></blockquote></div><div class="yiv2842901328yqt1677460141" id="yiv2842901328yqtfd21464"><span><font color="#888888"><br clear="none"><br clear="all"></font></span><div><br clear="none"></div>-- <br clear="none"><div>Anne Gentle<br clear="none"><a rel="nofollow" shape="rect" ymailto="mailto:annegentle@justwriteclick.com" target="_blank" href="mailto:annegentle@justwriteclick.com">annegentle@justwriteclick.com</a></div>
</div></div></div><div class="yiv2842901328yqt1677460141" id="yiv2842901328yqtfd22402">
</div></blockquote></div><div class="yiv2842901328yqt1677460141" id="yiv2842901328yqtfd51035"><br clear="none"></div></div><div class="yiv2842901328yqt1677460141" id="yiv2842901328yqtfd65855">
</div></div></div></blockquote></div><div class="yiv2842901328yqt1677460141" id="yiv2842901328yqtfd46435"><br clear="none"><br clear="all"><div><br clear="none"></div>-- <br clear="none"><div class="yiv2842901328gmail_signature">Anne Gentle<br clear="none"><a rel="nofollow" shape="rect" ymailto="mailto:annegentle@justwriteclick.com" target="_blank" href="mailto:annegentle@justwriteclick.com">annegentle@justwriteclick.com</a></div>
</div></div></div></div></div><br><div class="yqt1677460141" id="yqtfd89981">_______________________________________________<br clear="none">OpenStack-docs mailing list<br clear="none"><a shape="rect" ymailto="mailto:OpenStack-docs@lists.openstack.org" href="mailto:OpenStack-docs@lists.openstack.org">OpenStack-docs@lists.openstack.org</a><br clear="none"><a shape="rect" href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs" target="_blank">http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs</a><br clear="none"></div><br><br></div> </div> </div> </blockquote> </div></body></html>