You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@arrow.apache.org by "pitrou (via GitHub)" <gi...@apache.org> on 2023/05/16 13:58:45 UTC
[GitHub] [arrow] pitrou commented on a diff in pull request #35614: GH-32739: [CI][Docs] Document Docs PR Preview
pitrou commented on code in PR #35614:
URL: https://github.com/apache/arrow/pull/35614#discussion_r1195208773
##########
docs/source/developers/documentation.rst:
##########
@@ -102,6 +102,32 @@ The final output is located under the ``${PWD}/docs`` directory.
:ref:`docker-builds`.
+Pull Request Docs Preview
+-------------------------
+
+You can use github-actions to build and host the documentation with crossbow within
+a pull request you are working on.
Review Comment:
```suggestion
You can build and preview the documentation within a GitHub pull request you are working on.
```
##########
docs/source/developers/documentation.rst:
##########
@@ -102,6 +102,32 @@ The final output is located under the ``${PWD}/docs`` directory.
:ref:`docker-builds`.
+Pull Request Docs Preview
+-------------------------
Review Comment:
```suggestion
Building a docs preview in a Pull Request
-----------------------------------------
```
##########
docs/source/developers/documentation.rst:
##########
@@ -102,6 +102,32 @@ The final output is located under the ``${PWD}/docs`` directory.
:ref:`docker-builds`.
+Pull Request Docs Preview
+-------------------------
+
+You can use github-actions to build and host the documentation with crossbow within
+a pull request you are working on.
+
+To use github-actions add a 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:
Review Comment:
```suggestion
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:
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org