This is an automated email from the ASF dual-hosted git repository.
jorisvandenbossche pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/arrow.git
The following commit(s) were added to refs/heads/main by this push:
new b60bb96886 GH-32739: [CI][Docs] Document Docs PR Preview (#35614)
b60bb96886 is described below
commit b60bb968863f3e6d8bc08cae32b370ea64a3cc22
Author: Alenka Frim <[email protected]>
AuthorDate: Wed May 17 08:51:52 2023 +0200
GH-32739: [CI][Docs] Document Docs PR Preview (#35614)
Add Pull Request Docs Preview section to developers/documentation.rst.
* Closes: #32739
Lead-authored-by: Alenka Frim <[email protected]>
Co-authored-by: Alenka Frim <[email protected]>
Co-authored-by: Antoine Pitrou <[email protected]>
Signed-off-by: Joris Van den Bossche <[email protected]>
---
docs/source/developers/documentation.rst | 25 ++++++++++++++++++++++
docs/source/developers/images/docs_preview_1.jpeg | Bin 0 -> 33328 bytes
docs/source/developers/images/docs_preview_2.jpeg | Bin 0 -> 83093 bytes
3 files changed, 25 insertions(+)
diff --git a/docs/source/developers/documentation.rst
b/docs/source/developers/documentation.rst
index 497bce8f96..284de79dc1 100644
--- a/docs/source/developers/documentation.rst
+++ b/docs/source/developers/documentation.rst
@@ -102,6 +102,31 @@ The final output is located under the ``${PWD}/docs``
directory.
:ref:`docker-builds`.
+Building a docs preview in a Pull Request
+-----------------------------------------
+
+You can build and preview the documentation within a GitHub pull request you
are working on.
+
+To do so, post the comment ``@github-actions crossbow submit preview-docs``
+to the pull request. The rendered documentation will then be available within
the
+GitHub Actions response, where you need to click on the Crossbow build badge:
+
+.. figure:: /developers/images/docs_preview_1.jpeg
+ :scale: 70 %
+ :alt: Github-actions response with the crossbow build status.
+
+ Crossbow build status
+
+and then in the summary of the workflow you can find the link to the Docs
Preview
+summary at the bottom of the page:
+
+.. figure:: /developers/images/docs_preview_2.jpeg
+ :scale: 70 %
+ :alt: Crossbow workflow page with the Docs Preview summary section.
+
+ Docs Preview summary section
+
+
Building a single directory for dev purposes without all the pre-requisites
---------------------------------------------------------------------------
diff --git a/docs/source/developers/images/docs_preview_1.jpeg
b/docs/source/developers/images/docs_preview_1.jpeg
new file mode 100644
index 0000000000..6111f34b13
Binary files /dev/null and b/docs/source/developers/images/docs_preview_1.jpeg
differ
diff --git a/docs/source/developers/images/docs_preview_2.jpeg
b/docs/source/developers/images/docs_preview_2.jpeg
new file mode 100644
index 0000000000..3bf4f38185
Binary files /dev/null and b/docs/source/developers/images/docs_preview_2.jpeg
differ
