Merge branch 'master' of github.com:readthedocs/readthedocs.org into humitos/skip-contact-support

Author: humitos

.gitignore

@@ -67,6 +67,7 @@ env.bak/
 venv.bak/
 
 dev.db-journal
-/readthedocs/settings/build.py
-/readthedocs/settings/celery.py
-/readthedocs/settings/web.py
+/readthedocs/settings/build_docker.py
+/readthedocs/settings/celery_docker.py
+/readthedocs/settings/proxito_docker.py
+/readthedocs/settings/web_docker.py

.travis.yml

@@ -3,12 +3,18 @@ python:
   - 3.6
 dist: xenial
 
+addons:
+  hosts:
+    - search
+
 jobs:
   include:
     - python: 3.6
-      env: TOXENV=py36,codecov ES_VERSION=6.2.4 ES_DOWNLOAD_URL=https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-${ES_VERSION}.tar.gz
+      env: TOXENV=py36,codecov TOX_POSARGS='' ES_VERSION=6.2.4 ES_DOWNLOAD_URL=https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-${ES_VERSION}.tar.gz
     - python: 3.6
       env: TOXENV=docs
+    - python: 3.6
+      env: TOXENV=docs-linkcheck
     - python: 3.6
       env: TOXENV=docs-lint
     - python: 3.6
@@ -18,6 +24,9 @@ jobs:
       env: TOXENV=eslint NODE_VERSION=10.17.0
     - python: 3.6
       env: TOXENV=migrations
+
+  allow_failures:
+    - env: TOXENV=docs-linkcheck
 cache:
   directories:
     - ~/.cache/pip
@@ -28,7 +37,7 @@ install:
   - ./scripts/travis/install_node.sh
   - pip install tox-travis
 script:
-  - ./scripts/travis/run_tests.sh
+  - tox
 notifications:
   slack:
     rooms:

CHANGELOG.rst

@@ -1,3 +1,77 @@
+Version 4.0.2
+-------------
+
+:Date: March 04, 2020
+
+* `@ericholscher <https://github.com/ericholscher>`__: Don't call virtualenv with `--no-site-packages` (`#6738 <https://github.com/readthedocs/readthedocs.org/pull/6738>`__)
+* `@stsewd <https://github.com/stsewd>`__: Catch ConnectionError from request on api timing out (`#6735 <https://github.com/readthedocs/readthedocs.org/pull/6735>`__)
+* `@ericholscher <https://github.com/ericholscher>`__: Release 4.0.1 (`#6733 <https://github.com/readthedocs/readthedocs.org/pull/6733>`__)
+* `@humitos <https://github.com/humitos>`__: Improve Proxito 404 handler to render user-facing Maze when needed (`#6726 <https://github.com/readthedocs/readthedocs.org/pull/6726>`__)
+
+Version 4.0.1
+-------------
+
+:Date: March 03, 2020
+
+* `@ericholscher <https://github.com/ericholscher>`__: Add feature flag for branch & tag syncing to API. (`#6729 <https://github.com/readthedocs/readthedocs.org/pull/6729>`__)
+* `@stsewd <https://github.com/stsewd>`__: Don't fail a build on api timing out (`#6719 <https://github.com/readthedocs/readthedocs.org/pull/6719>`__)
+* `@stsewd <https://github.com/stsewd>`__: Be explicit on privacy level for search tests (`#6713 <https://github.com/readthedocs/readthedocs.org/pull/6713>`__)
+* `@stsewd <https://github.com/stsewd>`__: Make easy to run search tests in docker compose (`#6711 <https://github.com/readthedocs/readthedocs.org/pull/6711>`__)
+* `@davidfischer <https://github.com/davidfischer>`__: Docker settings improvements (`#6709 <https://github.com/readthedocs/readthedocs.org/pull/6709>`__)
+* `@davidfischer <https://github.com/davidfischer>`__: Workaround SameSite cookies (`#6708 <https://github.com/readthedocs/readthedocs.org/pull/6708>`__)
+* `@davidfischer <https://github.com/davidfischer>`__: Figure out the host IP when using Docker (`#6707 <https://github.com/readthedocs/readthedocs.org/pull/6707>`__)
+* `@davidfischer <https://github.com/davidfischer>`__: Pin the version of Azurite for docker-compose development (`#6706 <https://github.com/readthedocs/readthedocs.org/pull/6706>`__)
+* `@ericholscher <https://github.com/ericholscher>`__: Release 4.0.0 (`#6704 <https://github.com/readthedocs/readthedocs.org/pull/6704>`__)
+* `@humitos <https://github.com/humitos>`__: Rename docker settings to fix local environment (`#6703 <https://github.com/readthedocs/readthedocs.org/pull/6703>`__)
+* `@sduthil <https://github.com/sduthil>`__: API v3 doc: fix typos in URL for PATCH /versions/slug/ (`#6698 <https://github.com/readthedocs/readthedocs.org/pull/6698>`__)
+* `@humitos <https://github.com/humitos>`__: Sort vesions in-place to help performance (`#6696 <https://github.com/readthedocs/readthedocs.org/pull/6696>`__)
+* `@humitos <https://github.com/humitos>`__: Use .iterator when sorting versions (`#6694 <https://github.com/readthedocs/readthedocs.org/pull/6694>`__)
+* `@agjohnson <https://github.com/agjohnson>`__: Add feature flag to just completely skip sync and symlink operations (`#6689 <https://github.com/readthedocs/readthedocs.org/pull/6689>`__)
+* `@humitos <https://github.com/humitos>`__: Disable more loggings in development environment (`#6683 <https://github.com/readthedocs/readthedocs.org/pull/6683>`__)
+* `@davidfischer <https://github.com/davidfischer>`__: Use x-forwarded-host in local docker environment (`#6679 <https://github.com/readthedocs/readthedocs.org/pull/6679>`__)
+* `@humitos <https://github.com/humitos>`__: Allow user to set `build.image: testing` in the config file (`#6676 <https://github.com/readthedocs/readthedocs.org/pull/6676>`__)
+* `@agjohnson <https://github.com/agjohnson>`__: Add azurite --loose option (`#6669 <https://github.com/readthedocs/readthedocs.org/pull/6669>`__)
+* `@stsewd <https://github.com/stsewd>`__: Have more control over search tests (`#6644 <https://github.com/readthedocs/readthedocs.org/pull/6644>`__)
+* `@davidfischer <https://github.com/davidfischer>`__: Enable content security policy in report-only mode (`#6642 <https://github.com/readthedocs/readthedocs.org/pull/6642>`__)
+* `@stsewd <https://github.com/stsewd>`__: Add test settings file for proxito (`#6623 <https://github.com/readthedocs/readthedocs.org/pull/6623>`__)
+* `@stsewd <https://github.com/stsewd>`__: Guide: using private submodules in rtd.com (`#6527 <https://github.com/readthedocs/readthedocs.org/pull/6527>`__)
+
+Version 4.0.0
+-------------
+
+:Date: February 25, 2020
+
+**This release upgrades our codebase to run on Django 2.2**.
+This is a breaking change,
+so we have released it as our 4th major version.
+
+* `@stsewd <https://github.com/stsewd>`__: Data migration for old integration models (`#6675 <https://github.com/readthedocs/readthedocs.org/pull/6675>`__)
+* `@ericholscher <https://github.com/ericholscher>`__: Release 3.12.0 (`#6674 <https://github.com/readthedocs/readthedocs.org/pull/6674>`__)
+* `@humitos <https://github.com/humitos>`__: Upgrade to Django 2.2.9 (`#6494 <https://github.com/readthedocs/readthedocs.org/pull/6494>`__)
+* `@davidfischer <https://github.com/davidfischer>`__: Show message if version list truncated (`#6276 <https://github.com/readthedocs/readthedocs.org/pull/6276>`__)
+
+Version 3.12.0
+--------------
+
+:Date: February 18, 2020
+
+This version has two major changes:
+
+* It updates our default docker images to stable=5.0 and latest=6.0.
+* It changes our PR builder domain to `readthedocs.build`
+
+* `@humitos <https://github.com/humitos>`__: Use PUBLIC_DOMAIN_USES_HTTPS for resolver tests (`#6673 <https://github.com/readthedocs/readthedocs.org/pull/6673>`__)
+* `@stsewd <https://github.com/stsewd>`__: Always run CoreTagsTests with http (`#6671 <https://github.com/readthedocs/readthedocs.org/pull/6671>`__)
+* `@ericholscher <https://github.com/ericholscher>`__: Remove old docker settings (`#6670 <https://github.com/readthedocs/readthedocs.org/pull/6670>`__)
+* `@stsewd <https://github.com/stsewd>`__: Update gitpython and django (`#6667 <https://github.com/readthedocs/readthedocs.org/pull/6667>`__)
+* `@humitos <https://github.com/humitos>`__: New docker release (6.0 and testing) (`#6654 <https://github.com/readthedocs/readthedocs.org/pull/6654>`__)
+* `@humitos <https://github.com/humitos>`__: Default python version per Docker image (`#6653 <https://github.com/readthedocs/readthedocs.org/pull/6653>`__)
+* `@stsewd <https://github.com/stsewd>`__: Add pytest-custom_exit_code (`#6648 <https://github.com/readthedocs/readthedocs.org/pull/6648>`__)
+* `@ericholscher <https://github.com/ericholscher>`__: Initial attempt to serve PR builds at `readthedocs.build` (`#6629 <https://github.com/readthedocs/readthedocs.org/pull/6629>`__)
+* `@ericholscher <https://github.com/ericholscher>`__: Remove re-authing of users on downloads. (`#6619 <https://github.com/readthedocs/readthedocs.org/pull/6619>`__)
+* `@stsewd <https://github.com/stsewd>`__: Don't trigger a sync twice on creation/deletion for GitHub (`#6614 <https://github.com/readthedocs/readthedocs.org/pull/6614>`__)
+* `@s-weigand <https://github.com/s-weigand>`__: Add linkcheck test for the docs (`#6543 <https://github.com/readthedocs/readthedocs.org/pull/6543>`__)
+
 Version 3.11.6
 --------------
 
@@ -918,7 +992,7 @@ Version 3.2.2
 * `@pyup-bot <https://github.com/pyup-bot>`__: Pin pytest-cov to latest version 2.6.1 (`#5276 <https://github.com/readthedocs/readthedocs.org/pull/5276>`__)
 * `@pyup-bot <https://github.com/pyup-bot>`__: Pin pillow to latest version 5.4.1 (`#5275 <https://github.com/readthedocs/readthedocs.org/pull/5275>`__)
 * `@pyup-bot <https://github.com/pyup-bot>`__: Update elasticsearch to 6.3.1 (`#5274 <https://github.com/readthedocs/readthedocs.org/pull/5274>`__)
-* `@discdiver <https://github.com/discdiver>`__: clarify github integration needs https:// prepended (`#5273 <https://github.com/readthedocs/readthedocs.org/pull/5273>`__)
+* `@discdiver <https://github.com/discdiver>`__: clarify github integration needs ``https://`` prepended (`#5273 <https://github.com/readthedocs/readthedocs.org/pull/5273>`__)
 * `@humitos <https://github.com/humitos>`__: Setup and configure pyup.io (`#5272 <https://github.com/readthedocs/readthedocs.org/pull/5272>`__)
 * `@humitos <https://github.com/humitos>`__: Update all Python dependencies (`#5269 <https://github.com/readthedocs/readthedocs.org/pull/5269>`__)
 * `@davidfischer <https://github.com/davidfischer>`__: Add note about security issue (`#5263 <https://github.com/readthedocs/readthedocs.org/pull/5263>`__)

common

@@ -35,17 +35,17 @@ services:
     image: community_server:latest
     volumes:
       - ${PWD}:/usr/src/app/checkouts/readthedocs.org
-      - ${PWD}/dockerfiles/settings/proxito.py:/usr/src/app/checkouts/readthedocs.org/readthedocs/settings/proxito.py
+      - ${PWD}/dockerfiles/settings/proxito.py:/usr/src/app/checkouts/readthedocs.org/readthedocs/settings/proxito_docker.py
     environment:
-      - DJANGO_SETTINGS_MODULE=readthedocs.settings.proxito
+      - DJANGO_SETTINGS_MODULE=readthedocs.settings.proxito_docker
 
   web:
     image: community_server:latest
     volumes:
       - ${PWD}:/usr/src/app/checkouts/readthedocs.org
-      - ${PWD}/dockerfiles/settings/web.py:/usr/src/app/checkouts/readthedocs.org/readthedocs/settings/web.py
+      - ${PWD}/dockerfiles/settings/web.py:/usr/src/app/checkouts/readthedocs.org/readthedocs/settings/web_docker.py
     environment:
-      - DJANGO_SETTINGS_MODULE=readthedocs.settings.web
+      - DJANGO_SETTINGS_MODULE=readthedocs.settings.web_docker
       - HOSTIP=${HOSTIP:-}
     extra_hosts:
       - "community.dev.readthedocs.io:10.10.0.100"
@@ -54,29 +54,31 @@ services:
     image: community_server:latest
     volumes:
       - ${PWD}:/usr/src/app/checkouts/readthedocs.org
-      - ${PWD}/dockerfiles/settings/celery.py:/usr/src/app/checkouts/readthedocs.org/readthedocs/settings/celery.py
+      - ${PWD}/dockerfiles/settings/celery.py:/usr/src/app/checkouts/readthedocs.org/readthedocs/settings/celery_docker.py
     environment:
-      - DJANGO_SETTINGS_MODULE=readthedocs.settings.celery
+      - DJANGO_SETTINGS_MODULE=readthedocs.settings.celery_docker
       - CELERY_APP_NAME=readthedocs
 
   build:
     image: community_server:latest
     volumes:
       - ${PWD}:/usr/src/app/checkouts/readthedocs.org
-      - ${PWD}/dockerfiles/settings/build.py:/usr/src/app/checkouts/readthedocs.org/readthedocs/settings/build.py
+      - ${PWD}/dockerfiles/settings/build.py:/usr/src/app/checkouts/readthedocs.org/readthedocs/settings/build_docker.py
     environment:
-      - DJANGO_SETTINGS_MODULE=readthedocs.settings.build
+      - DJANGO_SETTINGS_MODULE=readthedocs.settings.build_docker
       - CELERY_APP_NAME=readthedocs
 
   storage:
-    image: mcr.microsoft.com/azure-storage/azurite:latest
+    # https://github.com/Azure/Azurite
+    # Pin the version of Azurite as there are sometimes backwards incompatible changes
+    image: mcr.microsoft.com/azure-storage/azurite:3.5.0
     volumes:
       - storage_data:/data
     ports:
       - "10000:10000"
     networks:
       readthedocs:
-    command: ["azurite-blob", "--silent", "--blobPort", "10000", "--blobHost", "0.0.0.0", "--location", "/data"]
+    command: ["azurite-blob", "--silent", "--blobPort", "10000", "--blobHost", "0.0.0.0", "--location", "/data", "--loose"]
 
   azure-cli:
     image: microsoft/azure-cli

docker-compose.override.yml

@@ -34,6 +34,9 @@ RUN sed -i -e 's/# en_US.UTF-8 UTF-8/en_US.UTF-8 UTF-8/' /etc/locale.gen && \
 
 RUN pip3 install --no-cache-dir --upgrade pip
 
+# Ensure that ``python`` is in the PATH so that ``./manage.py`` works
+RUN ln -s /usr/bin/python3 /usr/bin/python
+
 WORKDIR /tmp
 
 RUN curl -O https://raw.githubusercontent.com/readthedocs/readthedocs.org/master/requirements/pip.txt

dockerfiles/Dockerfile

@@ -1,14 +1,21 @@
 # Proxito
 server {
-    listen 80;
-    server_name *.community.dev.readthedocs.io;
+    listen 80 default_server;
+    server_name *.community.dev.readthedocs.io *.org.dev.readthedocs.build;
 
     # TODO: serve the favicon.ico from the project/version itself instead
     location /favicon.ico {
         proxy_pass http://storage:10000/devstoreaccount1/static/images/favicon.ico;
         break;
     }
 
+    # Redirect old URLs to our new domain
+    # external-builds.readthedocs.io/<type>/<slug>/<pr-number>/
+    location  ~* ^/html/(?P<project>.+)/(?P<version>.+)/(?P<path>.*) {
+        add_header X-Served Nginx-External-Redirect always;
+        rewrite ^ http://$project--$version.org.dev.readthedocs.build/page/$path;
+    }
+
     # Proxito doc serving
     location / {
         proxy_pass http://proxito:8000;
@@ -29,10 +36,12 @@ server {
         proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
         proxy_set_header X-Forwarded-Host $host;
 
+
         proxy_intercept_errors on;
         error_page 404 = @notfoundfallback;
 
         add_header X-Served Nginx-Proxito-Sendfile always;
+        add_header X-RTD-Project $upstream_http_x_rtd_project always;
     }
 
     # Serve 404 pages here

dockerfiles/nginx/proxito.conf

@@ -1,5 +1,7 @@
 server {
     listen 80;
+
+    # This should match settings.PRODUCTION_DOMAIN
     server_name community.dev.readthedocs.io;
 
     location /favicon.ico {
@@ -17,5 +19,6 @@ server {
 
     location / {
         proxy_pass http://web:8000/;
+        proxy_set_header X-Forwarded-Host $host;
     }
 }

dockerfiles/nginx/web.conf

@@ -1,25 +1,14 @@
+from readthedocs.settings.proxito.base import CommunityProxitoSettingsMixin
+
 from .docker_compose import DockerBaseSettings
 
 
-class ProxitoDevSettings(DockerBaseSettings):
-    ROOT_URLCONF = 'readthedocs.proxito.urls'
+class ProxitoDevSettings(CommunityProxitoSettingsMixin, DockerBaseSettings):
 
     # El Proxito does not have django-debug-toolbar installed
     DEBUG_TOOLBAR_CONFIG = {
         'SHOW_TOOLBAR_CALLBACK': lambda request: False,
     }
 
-    @property
-    def MIDDLEWARE(self):  # noqa
-        classes = list(super().MIDDLEWARE)
-        index = classes.index(
-            'readthedocs.core.middleware.SubdomainMiddleware'
-        )
-        # Use our new middleware instead of the old one
-        classes[index] = 'readthedocs.proxito.middleware.ProxitoMiddleware'
-        classes.remove('readthedocs.core.middleware.SingleVersionMiddleware')
-        classes.remove('django.middleware.locale.LocaleMiddleware')
-
-        return tuple(classes)
 
 ProxitoDevSettings.load_settings(__name__)

dockerfiles/settings/proxito.py

@@ -436,15 +436,15 @@ Version update
 
             $ curl \
               -X PATCH \
-              -H "Authorization: Token <token>" https://readthedocs.org/api/v3/projects/pip/version/0.23/ \
+              -H "Authorization: Token <token>" https://readthedocs.org/api/v3/projects/pip/versions/0.23/ \
               -H "Content-Type: application/json" \
               -d @body.json
 
         .. code-tab:: python
 
             import requests
             import json
-            URL = 'https://readthedocs.org/api/v3/projects/pip/ersion/0.23/'
+            URL = 'https://readthedocs.org/api/v3/projects/pip/versions/0.23/'
             TOKEN = '<token>'
             HEADERS = {'Authorization': f'token {TOKEN}'}
             data = json.load(open('body.json', 'rb'))

docs/api/v3.rst

@@ -103,6 +103,18 @@ def get_version():
 <p>Try using the search box or go to the homepage.</p>
 ''',
 }
+linkcheck_ignore = [
+    r'http://127\.0\.0\.1',
+    r'http://localhost',
+    r'https://yourproject\.readthedocs\.io',
+    r'https?://docs\.example\.com',
+    r'https://foo\.readthedocs\.io/projects',
+    r'https://github\.com.+?#L\d+',
+    r'https://github\.com/readthedocs/readthedocs\.org/issues',
+    r'https://github\.com/readthedocs/readthedocs\.org/pull',
+    r'https://docs\.readthedocs\.io/\?rtd_search',
+    r'https://readthedocs\.org/search',
+]
 
 
 def setup(app):

docs/conf.py

@@ -11,6 +11,7 @@ Local Development Configuration
 
 Installing and running Elasticsearch
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
 You need to install and run Elasticsearch_ version 6.3 on your local development machine.
 You can get the installation instructions
 `here <https://www.elastic.co/guide/en/elasticsearch/reference/6.3/install-elasticsearch.html>`_.
@@ -20,6 +21,8 @@ Otherwise, you can also start an Elasticsearch Docker container by running the f
            -e "discovery.type=single-node" \
            docker.elastic.co/elasticsearch/elasticsearch:6.3.2
 
+You need to override the ``ES_HOSTS`` and ``ELASTICSEARCH_DSL`` settings to point to ``127.0.0.1:9200``.
+
 Indexing into Elasticsearch
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
 For using search, you need to index data to the Elasticsearch Index. Run ``reindex_elasticsearch``

docs/development/search.rst

@@ -17,10 +17,20 @@ environments by running::
 
     tox
 
-In order to run all test including the search tests, include `"'--including-search'"`
-argument::
+By default, tox won't run tests from search,
+in order to run all test including the search tests,
+you need to override tox's posargs.
+If you don't have any additional arguments to pass,
+you can also set the ``TOX_POSARGS`` environment variable to an empty string::
 
-    tox "'--including-search'"
+    TOX_POSARGS='' tox
+
+.. note::
+
+   If you need to override tox's posargs, but you still don't want to run the search tests,
+   you need to include ``-m 'not search'`` to your command::
+
+       tox -- -m 'not search' -x
 
 .. warning::
 

docs/development/tests.rst

@@ -46,3 +46,14 @@ These guides will help you customize or tune aspects of Read the Docs.
     sitemaps
     specifying-dependencies
     wipe-environment
+
+
+Read the Docs for Business how-to guides
+----------------------------------------
+
+These guides are specific to :doc:`/commercial/index`.
+
+.. toctree::
+   :maxdepth: 1
+
+   private-submodules