Updated git submodules

[docs.git] / docs / documentation.rst

diff --git a/docs/documentation.rst b/docs/documentation.rst
index fdee59cc64474ac43e009a3226c840bf9cde21e5..471d6c88f14393b3e6d9f2ba7c72448a0d9e1e06 100644 (file)
--- a/docs/documentation.rst
+++ b/docs/documentation.rst
@@ -29,7 +29,7 @@ That being said, assuming that the content is usable, the bias should
 be toward merging it rather than blocking on relatively minor edits.
 
 Formatting Preferences
-^^^^^^^^^^^^^^^^^^^^^^
+----------------------
 
 In general, the documentation team has focused on trying to make sure
 that the instructions are comprehensible, but not being overly pedantic
@@ -40,7 +40,7 @@ following, generally they aren't a reason to -1 in and of themselves:
 * Line wrapping at something reasonable, i.e., 72–100 characters
 
 Key terms
-^^^^^^^^^
+---------
 
 * Functionality: something useful a project provides abstractly
 * Feature: a Karaf feature that somebody could install
@@ -54,7 +54,7 @@ Key terms
     other terms is hard.
 
 Common writing style mistakes
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+-----------------------------
 
 * In per-project user documentation, you should never say *git clone*,
   but should assume people have downloaded and installed the controller
@@ -72,7 +72,7 @@ Common writing style mistakes
   project.
 
 Grammar Preferences
-"""""""""""""""""""
+^^^^^^^^^^^^^^^^^^^
 
 * Avoid contractions: use cannot instead of can't, it is instead of
   it's, and the like.
@@ -233,10 +233,20 @@ the chapter should use::
     ^, for subsubsections
     ", for paragraphs
 
-
 Troubleshooting
 ---------------
 
+Nested formatting doesn't work
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+As stated in the reStructuredText_ guide, inline markup for bold,
+italic, and fixed-width can't be nested. Further, it can't be mixed
+with hyperlinks, so you can't have bold text link somewhere.
+
+This is tracked in a `Docutils FAQ question
+<http://docutils.sourceforge.net/FAQ.html#is-nested-inline-markup-possible>`,
+but there is no clear current plan to fix this.
+
 Make sure you've cloned submodules
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
@@ -342,14 +352,12 @@ itself and it contains a ``pom.xml`` file saying how to build it, a
 Troubleshooting
 ---------------
 
-See `AsciiDoc Tips
-<https://wiki.opendaylight.org/view/Documentation/Tools/AsciiDoc_Tips>`_
-on the wiki for more information.
+See `AsciiDoc Tips`_ on the wiki for more information.
 
 Common AsciiDoc mistakes
 ^^^^^^^^^^^^^^^^^^^^^^^^
 
-See also [[Documentation/Tools/AsciiDoc Tips|AsciiDoc Tips and Tricks]]
+See also `AsciiDoc Tips`_.
 
 * Lists that get formatted incorrectly because of no blank line above
   the list.
@@ -401,7 +409,7 @@ Image formats change from something like::
 
 To something like::
 
-   .. image:: images/dlux-default.png
+   .. figure:: images/dlux-default.png
 
 A helpful regular expression for automating the replacements is
 something like::
@@ -419,3 +427,4 @@ something like::
 .. _Documentation Group: https://wiki.opendaylight.org/view/Documentation/
 .. _RelEng/Builder: https://wiki.opendaylight.org/view/RelEng/Builder
 .. _Pandoc: http://pandoc.org/
+.. _AsciiDoc Tips: https://wiki.opendaylight.org/view/Documentation/Tools/AsciiDoc_Tips