<html> <head> <meta http-equiv="Content-Type" content="text/html; charset=us-ascii"> <style type="text/css" style="display:none;"></style> </head> <body dir="ltr"> <div id="divtagdefaultwrapper" style="font-size:12pt;color:#000000;font-family:Calibri,Helvetica,sans-serif;" dir="ltr"> <p style="margin-top:0;margin-bottom:0">Am I understanding this correctly, that you (ultimately) want to convert all existing reStructuredText documentation to markdown instead?</p> <p style="margin-top:0;margin-bottom:0"><br> </p> <p style="margin-top:0;margin-bottom:0">If so, will you also be updating the plugin template?</p> <p style="margin-top:0;margin-bottom:0">Or is pulp_file the reference implementation to watch here?</p> <p style="margin-top:0;margin-bottom:0"><br> </p> <p style="margin-top:0;margin-bottom:0">Currently pulp_deb is overdue for a major rework of its documentation, but I would like to avoid having to do that twice in a row. ;-)</p> <p style="margin-top:0;margin-bottom:0"><br> </p> <p style="margin-top:0;margin-bottom:0">regards,</p> <p style="margin-top:0;margin-bottom:0">Quirin Pamp</p> <p style="margin-top:0;margin-bottom:0"><br> </p> <p style="margin-top:0;margin-bottom:0"><br> </p> </div> <hr style="display:inline-block;width:98%" tabindex="-1"> <div id="divRplyFwdMsg" dir="ltr"><font face="Calibri, sans-serif" style="font-size:11pt" color="#000000"><b>From:</b> pulp-dev-bounces@redhat.com <pulp-dev-bounces@redhat.com> on behalf of Brian Bouterse <bmbouter@redhat.com><br> <b>Sent:</b> 01 May 2020 20:59:18<br> <b>To:</b> Fabricio Aguiar <fabricio.aguiar@redhat.com><br> <b>Cc:</b> Pulp-dev <pulp-dev@redhat.com><br> <b>Subject:</b> Re: [Pulp-dev] Markdown docs - pulpcore and plugins</font> <div> </div> </div> <div> <div dir="ltr"> <div>+1 to pulpcore and pulp_file switching to markdown. It's quicker to write and easier to read.</div> <div><br> </div> <div>Once a few days have passed for any concerns to be raised, if none are, then how about this for a plan?</div> <div><br> </div> <div>1) merge your PR for pulp_file</div> <div>2) verify that the docs show up on <a href="https://pulp-file.readthedocs.io/"> https://pulp-file.readthedocs.io/</a> correctly</div> <div>3) start into a PR to convert pulpcore documentation to markdown<br> </div> <div><br> </div> </div> <br> <div class="x_gmail_quote"> <div dir="ltr" class="x_gmail_attr">On Thu, Apr 30, 2020 at 3:01 PM Fabricio Aguiar <<a href="mailto:fabricio.aguiar@redhat.com">fabricio.aguiar@redhat.com</a>> wrote:<br> </div> <blockquote class="x_gmail_quote" style="margin:0px 0px 0px 0.8ex; border-left:1px solid rgb(204,204,204); padding-left:1ex"> <div dir="ltr">Due issue <a href="https://pulp.plan.io/issues/6518" target="_blank"> 6518</a>, about documenting the python clients, <div>I searched about how to use markdown on sphinx and found this [1]</div> <div>This helped me to document pulp_file client [2], currently, it introduces markdown docs from the client, keeping the pulp_file rst docs.</div> <div><br> </div> <div>Instead of getting mixed formats for docs, </div> <div>I propose we move our current docs to markdown, </div> <div>please share your thoughts! </div> <div><br> </div> <div>[1] <a href="https://www.sphinx-doc.org/en/master/usage/markdown.html" target="_blank">https://www.sphinx-doc.org/en/master/usage/markdown.html</a></div> <div>[2] <a href="https://github.com/pulp/pulp_file/pull/386" target="_blank">https://github.com/pulp/pulp_file/pull/386</a><br clear="all"> <div> <div dir="ltr"> <div dir="ltr"> <div dir="ltr"><br> Best regards,</div> <div dir="ltr"><span style="color:rgb(0,0,0); font-family:RedHatText,sans-serif; font-size:14px; font-weight:700; text-transform:capitalize">Fabricio</span><span style="color:rgb(0,0,0); font-family:RedHatText,sans-serif; font-size:14px; font-weight:700; text-transform:capitalize"> </span><span style="color:rgb(0,0,0); font-family:RedHatText,sans-serif; font-size:14px; font-weight:700; text-transform:capitalize">Aguiar</span> <div>Software Engineer, Pulp Project</div> <div><a href="https://www.redhat.com/" target="_blank" style="color:rgb(0,136,206); font-family:RedHatText,sans-serif; font-size:12px; margin:0px">Red Hat Brazil - Latam</a><br> </div> <div>+55 11 999652368</div> <div><img width="96" height="22" src="https://marketing-outfit-prod-images.s3-us-west-2.amazonaws.com/f5445ae0c9ddafd5b2f1836854d7416a/Logo-RedHat-Email.png"></div> </div> </div> </div> </div> </div> </div> _______________________________________________<br> Pulp-dev mailing list<br> <a href="mailto:Pulp-dev@redhat.com" target="_blank">Pulp-dev@redhat.com</a><br> <a href="https://www.redhat.com/mailman/listinfo/pulp-dev" rel="noreferrer" target="_blank">https://www.redhat.com/mailman/listinfo/pulp-dev</a><br> </blockquote> </div> </div> </body> </html>