summaryrefslogtreecommitdiffstats
path: root/docs/guides/onap-developer/how-to-use-docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs/guides/onap-developer/how-to-use-docs')
-rw-r--r--docs/guides/onap-developer/how-to-use-docs/converting-formats.rst8
1 files changed, 8 insertions, 0 deletions
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
-----------------