Design doc: collect data about builds

.circleci/config.yml

@@ -3,23 +3,34 @@ version: 2.1
 jobs:
   tests:
     docker:
-      - image: 'cimg/python:3.6'
+      - image: 'cimg/python:3.8'
         environment:
           TOX_POSARGS: ''
-      - image: 'docker.elastic.co/elasticsearch/elasticsearch:7.9.2'
+      - image: 'docker.elastic.co/elasticsearch/elasticsearch:7.14.0'
         name: search
         environment:
           discovery.type: single-node
+          ES_JAVA_OPTS: -Xms750m -Xmx750m
     steps:
       - checkout
       - run: git submodule sync
       - run: git submodule update --init
       - run: pip install --user tox
-      - run: tox -e py36,codecov
+      - run: tox -e py38,codecov
+
+  tests-embedapi:
+    docker:
+      - image: 'cimg/python:3.8'
+    steps:
+      - checkout
+      - run: git submodule sync
+      - run: git submodule update --init
+      - run: pip install --user tox
+      - run: tox -c tox.embedapi.ini
 
   checks:
     docker:
-      - image: 'cimg/python:3.6'
+      - image: 'cimg/python:3.8'
         environment:
           NODE_VERSION: 10.17.0
     steps:
@@ -34,9 +45,11 @@ jobs:
             echo 'export PATH=~/.nvm/versions/node/v${NODE_VERSION}/bin:$PATH' >> $BASH_ENV
             source $BASH_ENV
       - run: tox -e migrations
+      - run: tox -e pre-commit
       - run: tox -e lint
       - run: tox -e docs-lint
       - run: tox -e docs
+      - run: tox -e docs-dev
       - run: tox -e eslint
 
 workflows:
@@ -45,3 +58,4 @@ workflows:
     jobs:
       - checks
       - tests
+      - tests-embedapi

.github/CODEOWNERS

@@ -0,0 +1,3 @@
+*       @readthedocs/backend
+
+/docs/  @readthedocs/advocacy

.github/ISSUE_TEMPLATE/bug.md

@@ -0,0 +1,18 @@
+---
+name: Bug report
+about: Report some incorrect or unexpected behavior
+---
+
+## Details
+
+* Read the Docs project URL: https://readthedocs.org/projects/{your_project_slug}/
+* Build URL (if applicable): https://readthedocs.org/projects/{your_project_slug}/builds/{build_id}/
+* Read the Docs username (if applicable): https://readthedocs.org/profiles/{your_rtd_username}/
+
+## Expected Result
+
+*A description of what you wanted to happen*
+
+## Actual Result
+
+*A description of what actually happened*

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,7 @@
+contact_links:
+- name: User support
+  url: https://readthedocs.org/support/
+  about: |
+    If you need a specific request for your project or account,
+    like more resources, a specific feature flag,
+    change of the project slug or username, etc

.readthedocs.yml

@@ -1,22 +1,25 @@
 version: 2
+
 formats: all
+
 sphinx:
   configuration: docs/conf.py
+
 python:
   install:
     - requirements: requirements/pip.txt
     - requirements: requirements/docs.txt
 
+build:
+  os: ubuntu-20.04
+  tools:
+    python: "3.8"
+
 search:
-  ignore:
-    # Internal documentation
-    - development/design/*
-    - search.html
-    - 404.html
   ranking:
     # Deprecated content
     api/v1.html: -1
-    config-file/v1.html: -1
+    config-file/v1.html: -5
 
     # Useful content, but not something we want most users finding
     changelog.html: -6

dockerfiles/Dockerfile

@@ -1,4 +1,4 @@
-FROM ubuntu:18.04
+FROM ubuntu:20.04
 
 ARG GITHUB_TOKEN
 
@@ -50,6 +50,7 @@ RUN ln -s /usr/bin/python3 /usr/bin/python
 WORKDIR /tmp
 
 COPY requirements/pip.txt pip.txt
+COPY requirements/debug.txt debug.txt
 COPY requirements/docker.txt docker.txt
 RUN pip3 install --no-cache-dir -r docker.txt
 

dockerfiles/nginx/proxito.conf

@@ -62,10 +62,26 @@ server {
         add_header X-RTD-Project-Method $rtd_project_method always;
         set $rtd_redirect $upstream_http_x_rtd_redirect;
         add_header X-RTD-Redirect $rtd_redirect always;
+        set $cdn_cache_control $upstream_http_cdn_cache_control;
+        add_header CDN-Cache-Control $cdn_cache_control always;
         set $cache_tag $upstream_http_cache_tag;
         add_header Cache-Tag $cache_tag always;
         set $referrer_policy $upstream_http_referrer_policy;
         add_header Referrer-Policy $referrer_policy always;
+        set $permissions_policy $upstream_http_permissions_policy;
+        add_header Permissions-Policy $permissions_policy always;
+        set $feature_policy $upstream_http_feature_policy;
+        add_header Feature-Policy $feature_policy always;
+        set $access_control_allow_origin $upstream_http_access_control_allow_origin;
+        add_header Access-Control-Allow-Origin $access_control_allow_origin always;
+        set $access_control_allow_headers $upstream_http_access_control_allow_headers;
+        add_header Access-Control-Allow-Headers $access_control_allow_headers always;
+        set $x_frame_options $upstream_http_x_frame_options;
+        add_header X-Frame-Options $x_frame_options always;
+        # Minio sets this header on the response, and we don't want to copy it to the response
+        proxy_hide_header Content-Security-Policy;
+        set $content_security_policy $upstream_http_content_security_policy;
+        add_header Content-Security-Policy $content_security_policy always;
     }
 
     # Serve 404 pages here

docs/.rstcheck.cfg

@@ -1,7 +1,7 @@
 [rstcheck]
 ignore_directives=automodule,http:get,tabs,tab,prompt,http:patch,http:post,http:put,http:delete
 ignore_roles=djangosetting,setting,featureflags,buildpyversions
-ignore_substitutions=org_brand,com_brand,:smile:
+ignore_substitutions=org_brand,com_brand,:smile:,:arrows_counterclockwise:,:heavy_plus_sign:,:tada:,:heart:,:pencil2:
 # This error needs to be ignored for now
 # See: https://github.com/myint/rstcheck/issues/19
 ignore_messages=(Hyperlink target ".*" is not referenced)

docs/Makefile

@@ -5,7 +5,7 @@
 SPHINXOPTS    =
 SPHINXBUILD   = sphinx-build
 PAPER         =
-BUILDDIR      = _build
+BUILDDIR      = _build/$(RTD_DOCSET)
 
 # Do not use local Django settings during the docs build
 export DJANGO_SETTINGS_SKIP_LOCAL = True

docs/_static/css/custom.css

@@ -0,0 +1,11 @@
+.team-roster a img {
+  border-radius: 50%;
+  box-shadow: 0 0 0 7px #fff, 0 0 0 8px #cecece;
+  margin: 9px 17px 9px 3px;
+}
+
+
+/* Center the RTD placement when not wide enough to float */
+#rtd-stickybox-container {
+  text-align: center;
+}

docs/_templates/ethicalads.html

@@ -0,0 +1,3 @@
+<div id="rtd-stickybox-container">
+  <div class="raised" data-ea-publisher="readthedocs" data-ea-type="image" data-ea-style="stickybox"></div>
+</div>

docs/_templates/layout.html

@@ -0,0 +1,8 @@
+{% extends "!layout.html" %}
+
+
+{% block document %}
+  {{ super() }}
+
+  {% include "ethicalads.html" %}
+{% endblock document %}