From: Andrea Visnyei Date: Fri, 11 Sep 2020 10:48:44 +0000 (+0200) Subject: Intro paragraph added to Coverting to RST X-Git-Url: https://gerrit.onap.org/r/gitweb?p=doc.git;a=commitdiff_plain;h=bb258d5be6346d7ca71e4aaff8676a054ed6fde8 Intro paragraph added to Coverting to RST 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 --- diff --git a/docs/guides/onap-developer/how-to-use-docs/converting-formats.rst b/docs/guides/onap-developer/how-to-use-docs/converting-formats.rst index 835a9c5a2..56449beb2 100644 --- a/docs/guides/onap-developer/how-to-use-docs/converting-formats.rst +++ b/docs/guides/onap-developer/how-to-use-docs/converting-formats.rst @@ -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 -----------------