Skip to content

Commit 74df71d

Browse files
committed
Suggestions from review
1 parent 3182d83 commit 74df71d

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

docs/pull-requests.rst

+11-11
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
Preview Documentation from Pull Requests
22
========================================
33

4-
Read the Docs allows you to build and preview your documentation from pull/merge requests.
5-
To enable this feature:
4+
Read the Docs allows you to build and preview your documentation from pull requests.
5+
To enable this feature:
66

77
#. Go to your project dashboard
88
#. Go to :guilabel:`Admin > Advanced settings`
@@ -12,17 +12,17 @@ To enable this feature:
1212
Features
1313
--------
1414

15-
- **Build on Pull/Merge Request Events:** We create and build a new version when a pull/merge request is open,
15+
- **Build on Pull Request Events:** We create and build a new version when a pull request is open,
1616
and when a new commit has been pushed.
1717

18+
- **Build Status Report:** When a build is triggered, a build pending notification is sent with a link to the build log.
19+
When the build finishes we send a success notification with the link to the preview or a failure notification with a link to the build log.
20+
1821
- **Warning Banner:** A warning banner is shown at the top of the documentation
1922
to let users know that this isn't the main documentation for the project.
2023

2124
.. note:: This feature is available only for :doc:`Sphinx projects </intro/getting-started-with-sphinx>`.
2225

23-
- **Build Status Report:** When a build is triggered, a build pending notification is sent with a link to the build log.
24-
When the build finishes we send a success notification with the link to the preview or a failure notification with a link to the build log.
25-
2626
.. figure:: /_static/images/github-build-status-reporting.gif
2727
:align: center
2828
:alt: GitHub Build Status Reporting for Pull Requests.
@@ -38,20 +38,20 @@ Privacy levels
3838

3939
Privacy levels are only supported on :doc:`/commercial/index`.
4040

41-
All docs built from a pull/merge requests are private by default.
41+
All docs built from a pull requests are private by default.
4242
Currently, this can't be changed, but we are planning to support this.
4343

4444
Limitations
4545
-----------
4646

47-
- Auto-builds for pull/merge requests have
48-
:doc:`the same limitations as regular documentation builds </builds>`.
47+
- Builds from pull requests have the same memory and time limitations
48+
:doc:`as regular builds </builds>`.
4949
- Only available for GitHub and GitLab.
50-
- Additional formats like PDF and Epub aren't built to produce results quicker.
50+
- Additional formats like PDF and Epub aren't built to produce results quicker.
5151
- Searches will default to the default experience for your tool.
5252
This is a feature we plan to add,
5353
but don't want to overwhelm our search indexes used in production.
54-
- The built documentation is kept for 90 days after the pull/merge request has been closed or merged.
54+
- The built documentation is kept for 90 days after the pull request has been closed or merged.
5555

5656
Troubleshooting
5757
---------------

0 commit comments

Comments
 (0)