Skip to content

Commit 1b74999

Browse files
authored
Update support page (#10580)
* Update support page This addresses a few issues with the support page: - The first section mentions Stack Overflow, but we should probably highlight our search first - Adds some boundaries on our user support - Adds example questions back for user support - Directly calls out what we don't support - Description of our support is broken up and needed a few updates - Mentions reponse time of 1 day, which is accurate but doesn't match our pricing - Mention our support hours - Cleans up some of the language * Use "external resources" * Drop mention of support hours, include support upgrades note
1 parent 689e5c6 commit 1b74999

File tree

1 file changed

+33
-26
lines changed

1 file changed

+33
-26
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

0 commit comments

Comments
 (0)