Skip to content

Commit

Permalink
[DOCS] Add how to contribute TVM docs with images. (apache#10287)
Browse files Browse the repository at this point in the history
  • Loading branch information
Christian Convey authored and pfk-beta committed Apr 11, 2022
1 parent e4d620c commit 4f2396c
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions docs/contribute/document.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

0 comments on commit 4f2396c

Please sign in to comment.