Skip to content

Commit 475874b

Browse files
committed
Merge branch 'main' into replace-gitpython
2 parents a6e7f01 + e8bbe52 commit 475874b

File tree

4 files changed

+131
-125
lines changed

4 files changed

+131
-125
lines changed

docs/user/support.rst

+33-26
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,60 @@
11
Site support
22
============
33

4-
Usage questions
5-
---------------
4+
Read the Docs offers support for projects on our :doc:`Read the Docs for Business </commercial/index>` and |org_brand| platforms.
5+
We're happy to assist with any questions or problems you have using either of our platforms.
66

7-
If you have questions about how to use Read the Docs, or have an issue that
8-
isn't related to a bug, `Stack Overflow`_ is the best place to ask. Tag
9-
questions with ``read-the-docs`` so other folks can find them easily.
7+
.. note::
8+
Read the Docs does not offer support for questions or problems with documentation tools or content.
9+
If you have a question or problem using a particular documentation tool,
10+
you should refer to `external resources <External resources>`_ for help instead.
1011

11-
Good questions for Stack Overflow would be:
12+
Some examples of requests that we support are:
1213

13-
* "What is the best way to structure the table of contents across a project?"
14-
* "How do I structure translations inside of my project for easiest contribution from users?"
15-
* "How do I use Sphinx to use SVG images in HTML output but PNG in PDF output?"
14+
- "How do I transfer ownership of a Read the Docs project to another maintainer?"
15+
- "Why are my project builds being cancelled automatically?"
16+
- "How do I manage my subscription?"
1617

1718
You might also find the answers you are looking for in our :doc:`documentation guides </guides/index>`.
18-
These provide step-by-step solutions to common user requirements.
19+
These provide step-by-step solutions to common user requests.
20+
21+
.. tabs::
1922

20-
User support
21-
------------
23+
.. tab:: |com_brand|
2224

23-
If you need a specific request for your project or account,
24-
like more resources, change of the project's slug or username.
25+
Please fill out the form at https://readthedocs.com/support/.
2526

26-
.. tabs::
27+
Our team responds to support requests within 2 business days or earlier for most plans.
28+
Faster support response times and support SLAs are available with plan upgrades.
2729

2830
.. tab:: |org_brand|
2931

3032
Please fill out the form at https://readthedocs.org/support/,
3133
and we will reply as soon as possible.
3234

33-
.. tab:: |com_brand|
35+
External resources
36+
------------------
3437

35-
Please fill out the form at https://readthedocs.com/support/,
36-
and we will reply within 1 business day for most plans.
38+
If you have questions about how to use a documentation tool or authoring content for your project,
39+
or have an issue that isn't related to a bug with Read the Docs,
40+
`Stack Overflow`_ is the best place for your question.
41+
42+
Examples of good questions for Stack Overflow are:
43+
44+
* "What is the best way to structure the table of contents across a project?"
45+
* "How do I structure translations inside of my project for easiest contribution from users?"
46+
* "How do I use Sphinx to use SVG images in HTML output but PNG in PDF output?"
47+
48+
.. tip::
49+
Tag questions with ``read-the-docs`` so other folks can find them easily.
3750

3851
Bug reports
3952
-----------
4053

41-
If you have an issue with the actual functioning of the site,
54+
If you have an issue with the actual functioning of Read the Docs,
4255
you can file bug reports on our `GitHub issue tracker`_.
43-
You can also :doc:`contribute <rtd-dev:contribute>` to Read the Docs,
56+
You can also :doc:`contribute changes and fixes <rtd-dev:contribute>` to Read the Docs,
4457
as the code is open source.
4558

46-
Priority support
47-
----------------
48-
49-
We offer priority support with :doc:`Read the Docs for Business </commercial/index>`
50-
and we have a dedicated team that responds to support requests during business hours.
51-
5259
.. _Stack Overflow: https://stackoverflow.com/questions/tagged/read-the-docs
5360
.. _Github issue tracker: https://github.com/readthedocs/readthedocs.org/issues
+11-12
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,20 @@
1-
21
"""Template context processors for core app."""
32

43
from django.conf import settings
54

65

76
def readthedocs_processor(request):
8-
# pylint: disable=unused-argument
97
exports = {
10-
'PUBLIC_DOMAIN': settings.PUBLIC_DOMAIN,
11-
'PRODUCTION_DOMAIN': settings.PRODUCTION_DOMAIN,
12-
'USE_SUBDOMAIN': settings.USE_SUBDOMAIN,
13-
'GLOBAL_ANALYTICS_CODE': settings.GLOBAL_ANALYTICS_CODE,
14-
'DASHBOARD_ANALYTICS_CODE': settings.DASHBOARD_ANALYTICS_CODE,
15-
'SITE_ROOT': settings.SITE_ROOT + '/',
16-
'TEMPLATE_ROOT': settings.TEMPLATE_ROOT + '/',
17-
'DO_NOT_TRACK_ENABLED': settings.DO_NOT_TRACK_ENABLED,
18-
'USE_PROMOS': settings.USE_PROMOS,
19-
'SUPPORT_EMAIL': settings.SUPPORT_EMAIL,
8+
"PUBLIC_DOMAIN": settings.PUBLIC_DOMAIN,
9+
"PRODUCTION_DOMAIN": settings.PRODUCTION_DOMAIN,
10+
"USE_SUBDOMAIN": settings.USE_SUBDOMAIN,
11+
"GLOBAL_ANALYTICS_CODE": settings.GLOBAL_ANALYTICS_CODE,
12+
"DASHBOARD_ANALYTICS_CODE": settings.DASHBOARD_ANALYTICS_CODE,
13+
"SITE_ROOT": settings.SITE_ROOT + "/",
14+
"TEMPLATE_ROOT": settings.TEMPLATE_ROOT + "/",
15+
"DO_NOT_TRACK_ENABLED": settings.DO_NOT_TRACK_ENABLED,
16+
"USE_PROMOS": settings.USE_PROMOS,
17+
"USE_ORGANIZATIONS": settings.RTD_ALLOW_ORGANIZATIONS,
18+
"SUPPORT_EMAIL": settings.SUPPORT_EMAIL,
2019
}
2120
return exports

readthedocs/rtd_tests/tests/test_api.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -405,7 +405,7 @@ def test_make_build_commands(self):
405405
"command": "$READTHEDOCS_VIRTUALENV_PATH/bin/python -m sphinx",
406406
"description": "Python and Sphinx command",
407407
"exit_code": 0,
408-
"start_time": start_time,
408+
"start_time": start_time + datetime.timedelta(seconds=1),
409409
"end_time": end_time,
410410
},
411411
format='json',

0 commit comments

Comments
 (0)