Merge branch 'master' of github.com:readthedocs/readthedocs.org into remote-repository-normalization

Author: humitos

.readthedocs.yml

@@ -21,3 +21,4 @@ search:
     # Useful content, but not something we want most users finding
     custom_installs/*: -6
     changelog.html: -6
+    development/install.html: -6

CHANGELOG.rst

@@ -1,3 +1,23 @@
+Version 5.11.0
+--------------
+
+:Date: March 02, 2021
+
+* `@saadmk11 <https://github.com/saadmk11>`__: Add management command to Load Project and RemoteRepository Relationship from JSON file (`#7966 <https://github.com/readthedocs/readthedocs.org/pull/7966>`__)
+* `@humitos <https://github.com/humitos>`__: Lower rank of development/install.html (`#7960 <https://github.com/readthedocs/readthedocs.org/pull/7960>`__)
+* `@saadmk11 <https://github.com/saadmk11>`__: Add Management Command to Dump Project and RemoteRepository Relationship in JSON format (`#7957 <https://github.com/readthedocs/readthedocs.org/pull/7957>`__)
+* `@davidfischer <https://github.com/davidfischer>`__: Enable the cached template loader (`#7953 <https://github.com/readthedocs/readthedocs.org/pull/7953>`__)
+* `@stsewd <https://github.com/stsewd>`__: Update common to master (`#7951 <https://github.com/readthedocs/readthedocs.org/pull/7951>`__)
+* `@stsewd <https://github.com/stsewd>`__: Embed: refactor tests (`#7947 <https://github.com/readthedocs/readthedocs.org/pull/7947>`__)
+* `@stsewd <https://github.com/stsewd>`__: Downgrade jedi (`#7946 <https://github.com/readthedocs/readthedocs.org/pull/7946>`__)
+* `@FatGrizzly <https://github.com/FatGrizzly>`__: Added warnings for previous gitbook users (`#7945 <https://github.com/readthedocs/readthedocs.org/pull/7945>`__)
+* `@stsewd <https://github.com/stsewd>`__: Move embed app (`#7943 <https://github.com/readthedocs/readthedocs.org/pull/7943>`__)
+* `@ericholscher <https://github.com/ericholscher>`__: Change our sponsored hosting from Azure -> AWS. (`#7940 <https://github.com/readthedocs/readthedocs.org/pull/7940>`__)
+* `@Pradhvan <https://github.com/Pradhvan>`__: Docs: Adds Myst to the getting started with sphinx (`#7938 <https://github.com/readthedocs/readthedocs.org/pull/7938>`__)
+* `@ericholscher <https://github.com/ericholscher>`__: Add a support form to the website (`#7929 <https://github.com/readthedocs/readthedocs.org/pull/7929>`__)
+* `@stsewd <https://github.com/stsewd>`__: Drop six (`#7890 <https://github.com/readthedocs/readthedocs.org/pull/7890>`__)
+* `@fabianmp <https://github.com/fabianmp>`__: Allow to use a different url for intersphinx object file download (`#7807 <https://github.com/readthedocs/readthedocs.org/pull/7807>`__)
+
 Version 5.10.0
 --------------
 

common

@@ -127,6 +127,11 @@ You will need to update your CAA records to allow us to issue the certificate.
 .. _Cloudflare CAA FAQ: https://support.cloudflare.com/hc/en-us/articles/115000310832-Certification-Authority-Authorization-CAA-FAQ
 .. _Amazon CAA guide: https://docs.aws.amazon.com/acm/latest/userguide/setup-caa.html
 
+.. note::
+ 
+   If your custom domain was previously used in GitBook, contact GitBook support (via live chat in their website)
+   to remove the domain name from their DNS Zone in order for your domain name to work with Read the Docs,
+   else it will always redirect to GitBook.
 
 Proxy SSL
 ---------

docs/custom_domains.rst

@@ -8,19 +8,18 @@ Diagram
 ::
 
                                       +-----------+
-                                      | Azure     |
                                 +-----| Load Bal  |------+
                                 |     +-----------+      |
                                 |                        |
-                           +---------+              +---------+                                  
-       +-------------+     |         |              |         |    +--------------+              
-       |             |-----| Nginx   |              | Nginx   |----|              |              
-       |  File       |     +---------+              +---------+    |  File        |              
-       |  System     |          |                        |         |  System      |              
-       +-------------+     +---------+  +--------+  +---------+    +--------------+              
-              |  |         |Gunicorn |  |        |  |Gunicorn |        |   |                     
-              |  +---------|(Django) |--|Postgres|--|(Django) |--------+   |                     
-              |            +---------+  +--------+  +---------+            |                     
+                           +---------+              +---------+
+       +-------------+     |         |              |         |    +--------------+
+       |             |-----| Nginx   |              | Nginx   |----|              |
+       |  File       |     +---------+              +---------+    |  File        |
+       |  System     |          |                        |         |  System      |
+       +-------------+     +---------+  +--------+  +---------+    +--------------+
+              |  |         |Gunicorn |  |        |  |Gunicorn |        |   |
+              |  +---------|(Django) |--|Postgres|--|(Django) |--------+   |
+              |            +---------+  +--------+  +---------+            |
               |                 |                        |                 |
               |                 |                        |                 |
               |                 -----------API------------                 |
@@ -29,12 +28,12 @@ Diagram
               |                     +------------------+                   |
               |                     |                  |                   |
               +---------------------|  Build Server    |-------------------+
-                                    |                  |              
-                                    +------------------+       
-                                                               
-                                                               
-                                                               
-                                                               
+                                    |                  |
+                                    +------------------+
+
+
+
+
 
 
 

docs/development/architecture.rst

@@ -38,6 +38,14 @@ Default: :djangosetting:`PRODUCTION_DOMAIN`
 This is the domain that gets linked to throughout the site when used in production.
 It depends on `USE_SUBDOMAIN`, otherwise it isn't used.
 
+RTD_INTERSPHINX_URL
+-------------------
+
+Default: :djangosetting:`RTD_INTERSPHINX_URL`
+
+This is the domain that is used to fetch the intersphinx inventory file.
+If not set explicitly this is the ``PRODUCTION_DOMAIN``.
+
 MULTIPLE_APP_SERVERS
 --------------------
 

docs/development/settings.rst

@@ -51,8 +51,8 @@ Celery is isolated from database
 Use NGINX as web server
     All the site is served via NGINX with the ability to change some configuration locally.
 
-Azurite as Django storage backend
-    All static and media files are served using Azurite --an emulator of Azure Blob Storage,
+MinIO as Django storage backend
+    All static and media files are served using Minio --an emulator of S3,
     which is the one used in production.
 
 Serve documentation via El Proxito

docs/development/standards.rst

@@ -91,24 +91,26 @@ by :doc:`importing your docs </intro/import-guide>`.
 Using Markdown with Sphinx
 --------------------------
 
-You can use Markdown and reStructuredText in the same Sphinx project.
+You can use `Markdown using MyST`_ and reStructuredText in the same Sphinx project.
 We support this natively on Read the Docs, and you can do it locally:
 
 .. prompt:: bash $
 
-    pip install recommonmark
+    pip install myst-parser
 
 Then in your ``conf.py``:
 
 .. code-block:: python
 
-   extensions = ['recommonmark']
+   extensions = ['myst-parser']
 
-.. warning:: Markdown doesn't support a lot of the features of Sphinx,
-          like inline markup and directives. However, it works for
-          basic prose content. reStructuredText is the preferred
-          format for technical documentation, please read `this blog post`_
-          for motivation.
+.. warning::
+
+   Markdown does works for basic prose content.
+   But reStructuredText is the preferred format for technical documentation,
+   please read `this blog post`_ for motivation.
+
+.. _Markdown using MyST: https://myst-parser.readthedocs.io/en/latest/using/intro.html
 
 .. _this blog post: https://www.ericholscher.com/blog/2016/mar/15/dont-use-markdown-for-technical-docs/
 

docs/intro/getting-started-with-sphinx.rst

@@ -9,13 +9,14 @@ supporting us.
 Current sponsors
 ----------------
 
-* `Microsoft Azure`_ - They cover all of our hosting expenses every month.  This is a pretty large sum of money, averaging around $3,000/mo, and we are really grateful to have them as a sponsor.
+* `AWS`_ - They cover all of our hosting expenses every month.  This is a pretty large sum of money, averaging around $5,000/mo.
 * `Cloudflare`_ - Cloudflare is providing us with an enterprise plan of their SSL for SaaS Providers product that enables us to provide SSL certificates for custom domains.
-* You? (Email us at rev@readthedocs.org for more info)
+* You? (Email us at hello@readthedocs.org for more info)
 
 Past sponsors
 -------------
 
+* `Microsoft Azure`_
 * `Python Software Foundation`_
 * `Revsys`_
 * `Mozilla Web Dev`_
@@ -34,6 +35,7 @@ Past sponsors
 .. _Twilio: https://www.twilio.com/
 .. _Cloudflare: https://www.cloudflare.com/
 .. _Microsoft Azure: https://azure.microsoft.com/
+.. _AWS: https://aws.amazon.com/
 
 
 Sponsorship Information

docs/sponsors.rst

@@ -1,5 +1,5 @@
-Support
-=======
+Site Support
+============
 
 Usage Questions
 ---------------
@@ -14,34 +14,34 @@ Good questions for Stack Overflow would be:
 * "How do I structure translations inside of my project for easiest contribution from users?"
 * "How do I use Sphinx to use SVG images in HTML output but PNG in PDF output?"
 
+You might also find the answers you are looking for in our :doc:`documentation guides </guides/index>`.
+These provide step-by-step solutions to common user requirements.
+
 User Support
 ------------
 
 If you need a specific request for your project or account,
 like more resources, change of the project's slug or username.
-Send an email to [email protected].
-We will get to you as soon as possible.
 
-Bug Reports
------------
+.. tabs::
+
+   .. tab:: |org_brand|
 
-You can file bug reports on our `GitHub issue tracker`_,
-and they will be addressed as soon as possible.
-Please only file issues with our actual codebase there,
-not user support questions
+        Please fill out the form at https://readthedocs.org/support/,
+        and we will reply as soon as possible.
 
-Reporting Issues
-~~~~~~~~~~~~~~~~
+   .. tab:: |com_brand|
 
-When reporting a bug,
-please include as much information as possible that will help us solve this issue.
-This includes:
+        Please fill out the form at https://readthedocs.com/support/,
+        and we will reply within 1 business day for most plans.
+
+Bug Reports
+-----------
 
-* Project name
-* URL
-* Action taken
-* Expected result
-* Actual result
+If you have an issue with the actual functioning of the site,
+you can file bug reports on our `GitHub issue tracker`_.
+You can also :doc:`contribute </contribute>` to Read the Docs,
+as the code is open source.
 
 Priority Support
 ----------------
@@ -50,6 +50,4 @@ We offer priority support with :doc:`Read the Docs for Business </commercial/ind
 and we have a dedicated team that responds to support requests during business hours.
 
 .. _Stack Overflow: https://stackoverflow.com/questions/tagged/read-the-docs
-.. _Github Issue Tracker: https://github.com/readthedocs/readthedocs.org/issues
-.. _Gold: https://readthedocs.org/accounts/gold/
-.. _Ethical Ads: https://docs.readthedocs.io/en/latest/ethical-advertising.html
+.. _Github issue tracker: https://github.com/readthedocs/readthedocs.org/issues

docs/support.rst

@@ -1,6 +1,6 @@
 {
   "name": "readthedocs",
-  "version": "5.10.0",
+  "version": "5.11.0",
   "description": "Read the Docs build dependencies",
   "author": "Anthony Johnson <[email protected]>",
   "scripts": {

media/images/sponsors/aws.png

@@ -53,44 +53,6 @@ def make_document_url(project, version=None, page='', path=''):
     return resolve(project=project, version_slug=version, filename=filename)
 
 
-@register.filter(is_safe=True)
-def restructuredtext(value, short=False):
-    try:
-        from docutils.core import publish_parts
-        from docutils import ApplicationError
-    except ImportError:
-        if settings.DEBUG:
-            raise template.TemplateSyntaxError(
-                "Error in 'restructuredtext' filter: "
-                "The Python docutils library isn't installed.",
-            )
-        return force_text(value)
-    else:
-        docutils_settings = {
-            'raw_enabled': False,
-            'file_insertion_enabled': False,
-        }
-        docutils_settings.update(
-            settings.RESTRUCTUREDTEXT_FILTER_SETTINGS,
-        )
-        try:
-            parts = publish_parts(
-                source=force_bytes(value),
-                writer_name='html4css1',
-                settings_overrides=docutils_settings,
-            )
-        except ApplicationError:
-            return force_text(value)
-
-        out = force_text(parts['fragment'])
-        try:
-            if short:
-                out = out.split('\n')[0]
-        except IndexError:
-            pass
-        return mark_safe(out)
-
-
 @register.filter
 def get_project(slug):
     try:

package.json

@@ -34,6 +34,17 @@ def get_context_data(self, **kwargs):
         return context
 
 
+class SupportView(TemplateView):
+
+    template_name = 'support/index.html'
+
+    def get_context_data(self, **kwargs):
+        """Pass along endpoint for support form."""
+        context = super().get_context_data(**kwargs)
+        context['SUPPORT_FORM_ENDPOINT'] = settings.SUPPORT_FORM_ENDPOINT
+        return context
+
+
 def wipe_version(request, project_slug, version_slug):
     version = get_object_or_404(
         Version.internal.all(),