This is an automated email from the ASF dual-hosted git repository.
masahi pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/tvm.git
The following commit(s) were added to refs/heads/main by this push:
new 329d8a5 [DOCS] Add how to contribute TVM docs with images. (#10287)
329d8a5 is described below
commit 329d8a5440a76f7aa7686696f98b15278b817d15
Author: Christian Convey <[email protected]>
AuthorDate: Fri Feb 25 15:51:17 2022 -0500
[DOCS] Add how to contribute TVM docs with images. (#10287)
---
docs/contribute/document.rst | 18 ++++++++++++++++++
1 file changed, 18 insertions(+)
diff --git a/docs/contribute/document.rst b/docs/contribute/document.rst
index 8658c0f..ffd6349 100644
--- a/docs/contribute/document.rst
+++ b/docs/contribute/document.rst
@@ -233,3 +233,21 @@ Please use sphinx's ``:ref:`` markup to refer to another
location in the same do
----------
You can use :ref:`document-my-section-tag` to refer to My Section.
+
+Documents with Images / Figures
+-------------------------------
+reStructuredText's `figure
<https://docutils.sourceforge.io/docs/ref/rst/directives.html#figure>`_
+and `image
<https://docutils.sourceforge.io/docs/ref/rst/directives.html#image>`_
+elements allow a document to include an image URL.
+
+Image files created for TVM documentation should reside in the
`<https://github.com/tlc-pack/web-data>`_
+repository, while the `.rst` files *using* those images should reside in the
main TVM repostitory
+(`<https://github.com/apache/tvm>`_).
+
+This will require two Github Pull Requests, one for the image files and
another for the `.rst` files.
+Discussion between the contributor and reviewers may be necessary to
coordinate the review process.
+
+*IMPORTANT NOTE:* When using two Pull Requests as described above, please
merge the
+Pull Request in `<https://github.com/tlc-pack/web-data>`_ *before* merging
+the Pull Request in `<https://github.com/apache/tvm>`_.
+This helps ensure that all URL links in TVM's online documentation are valid.
