Intro paragraph added to Coverting to RST 26/112526/1
authorAndrea Visnyei <andrea.visnyei@nokia.com>
Fri, 11 Sep 2020 10:48:44 +0000 (12:48 +0200)
committerAndrea Visnyei <andrea.visnyei@nokia.com>
Fri, 11 Sep 2020 10:48:44 +0000 (12:48 +0200)
Some introductory information has been added to Converting to RST chapter of documentation guide.

Issue-ID: DOC-666

Change-Id: Ic488145c995c40a507a9bb6759c9263a4f62a9b8
Signed-off-by: Andrea Visnyei <andrea.visnyei@nokia.com>
docs/guides/onap-developer/how-to-use-docs/converting-formats.rst

index 835a9c5..56449be 100644 (file)
@@ -7,6 +7,14 @@
 Converting to RST
 =================
 
+RST format is used for documentation. Other file formats can be converted to RST
+with pandoc.
+
+.. caution::
+
+  Always check the output text after conversion. For the most common errors,
+  see section Fixing the converted document.
+
 Installing pandoc
 -----------------