openstack-manuals/doc/doc-contrib-guide/source/rst-conv/comment.rst
Alexandra Settle 85107272be [contrib-guide] Updating url to doc-contrib-guide
Based off conversation at the PTG, we agreed it would be
beneficial to ensure the contrib-guide is clearly marked
as the doc contrib guide outside of the title.

This change includes a redirect.

Change-Id: I5abf915f0b94a482afa961e6b86364c26aae5d79
2017-09-22 14:57:47 +00:00

411 B

Comments

Indicate a comment by means of the .. marker.

Input

.. This is a comment. It is not visible in the documentation build.
   Generally, use it to include TODO within the content followed
   by the initials of the person who is to perform the action.

For example:

.. TODO(OG): add a link to the Decorations section when it is available.