<html><head></head><body>Is there a lint tool that can catch incoherent markup at a global project level (vs at a page gen level)?<br>
<br>
Any tool to catch these issues would help.<br>
<br>
JP.<br><br><div class="gmail_quote">On July 19, 2018 3:55:29 PM UTC, Petr Kovar <pkovar@redhat.com> wrote:<blockquote class="gmail_quote" style="margin: 0pt 0pt 0pt 0.8ex; border-left: 1px solid rgb(204, 204, 204); padding-left: 1ex;">
<pre class="k9mail">Hi all,<br><br>A spin-off discussion in <a href="https://review.openstack.org/#/c/579177/">https://review.openstack.org/#/c/579177/</a> resulted<br>in an idea to update our RST conventions for headings level 2 and 3 so that<br>our guidelines follow recommendations from<br><a href="http://docutils.sourceforge.net/docs/user/rst/quickstart.html#sections.">http://docutils.sourceforge.net/docs/user/rst/quickstart.html#sections.</a><br><br>The updated conventions also better reflect what most projects have been<br>using already, regardless of what was previously in our conventions.<br><br>To sum up, for headings level 2, use dashes:<br><br>Heading 2<br>---------<br><br>For headings level 3, use tildes:<br><br>Heading 3<br>~~~~~~~~~<br><br>For details on the change, see:<br><br><a href="https://review.openstack.org/#/c/583239/1/doc/doc-contrib-guide/source/rst-conv/titles.rst">https://review.openstack.org/#/c/583239/1/doc/doc-contrib-guide/source/rst-conv/titles.rst</a><br><br>Thanks,<br>pk<br><br><br>On Fri, 29 Jun 2018 16:45:53 +0200<br>Petr Kovar <pkovar@redhat.com> wrote:<br><br><blockquote class="gmail_quote" style="margin: 0pt 0pt 1ex 0.8ex; border-left: 1px solid #729fcf; padding-left: 1ex;"> Hi all,<br> <br> Feedback from the Queens PTG included requests for the Documentation<br> Project to provide guidance and recommendations on how to structure common<br> content typically found on the front page for project team docs, located at<br> doc/source/index.rst in the project team repository.<br> <br> I've created a new docs spec, proposing a template to be used by project<br> teams, and would like to ask the OpenStack community and, specifically, the<br> project teams, to take a look, submit feedback on the spec, share<br> comments, ideas, or concerns:<br> <br> <a href="https://review.openstack.org/#/c/579177/">https://review.openstack.org/#/c/579177/</a><br> <br> The main goal of providing and using this template is to make it easier for<br> users to find, navigate, and consume project team documentation, and for<br> contributors to set up and maintain the project team docs.<br> <br> The template would also serve as the basis for one of the future governance<br> docs tags, which is a long-term plan for the docs team.<br> <br> Thank you,<br> pk<br> <br><hr><br> OpenStack Development Mailing List (not for usage questions)<br> Unsubscribe: OpenStack-dev-request@lists.openstack.org?subject:unsubscribe<br> <a href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev">http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev</a><br></blockquote><br><br><hr><br>OpenStack Development Mailing List (not for usage questions)<br>Unsubscribe: OpenStack-dev-request@lists.openstack.org?subject:unsubscribe<br><a href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev">http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev</a><br></pre></blockquote></div><br>
-- <br>
Sent from my Android device with K-9 Mail. Please excuse my brevity.</body></html>