Merge tag '11.6.0' into rel

Author: humitos

CHANGELOG.rst

@@ -1,3 +1,20 @@
+Version 11.6.0
+--------------
+
+:Date: August 20, 2024
+
+* `@stsewd <https://github.com/stsewd>`__: Update common (`#11552 <https://github.com/readthedocs/readthedocs.org/pull/11552>`__)
+* `@humitos <https://github.com/humitos>`__: Docs: make translation section more generic (`#11549 <https://github.com/readthedocs/readthedocs.org/pull/11549>`__)
+* `@webknjaz <https://github.com/webknjaz>`__: Fix a typo in "invited" in email notification subjects (`#11546 <https://github.com/readthedocs/readthedocs.org/pull/11546>`__)
+* `@mgeier <https://github.com/mgeier>`__: Update instructions for Jupyter notebook galleries (`#11545 <https://github.com/readthedocs/readthedocs.org/pull/11545>`__)
+* `@agjohnson <https://github.com/agjohnson>`__: Drop "Unknown message" notification (`#11542 <https://github.com/readthedocs/readthedocs.org/pull/11542>`__)
+* `@stsewd <https://github.com/stsewd>`__: Login: add link to SAML login (`#11541 <https://github.com/readthedocs/readthedocs.org/pull/11541>`__)
+* `@robredpath <https://github.com/robredpath>`__: Update i18n docs for Sphinx (`#11538 <https://github.com/readthedocs/readthedocs.org/pull/11538>`__)
+* `@humitos <https://github.com/humitos>`__: Release 11.5.0 (`#11537 <https://github.com/readthedocs/readthedocs.org/pull/11537>`__)
+* `@humitos <https://github.com/humitos>`__: Slack: use json= to send a message using webhooks (`#11536 <https://github.com/readthedocs/readthedocs.org/pull/11536>`__)
+* `@humitos <https://github.com/humitos>`__: Addons: add a notification on each Sphinx build (`#11514 <https://github.com/readthedocs/readthedocs.org/pull/11514>`__)
+* `@stsewd <https://github.com/stsewd>`__: Ask for confirmation when adding a user to a project/organization/team (`#9440 <https://github.com/readthedocs/readthedocs.org/pull/9440>`__)
+
 Version 11.5.0
 --------------
 

common

@@ -76,7 +76,7 @@
 
 master_doc = "index"
 copyright = "Read the Docs, Inc & contributors"
-version = "11.5.0"
+version = "11.6.0"
 release = version
 exclude_patterns = ["_build", "shared", "_includes"]
 default_role = "obj"

docs/conf.py

@@ -237,21 +237,8 @@ Creating galleries of examples using notebooks
 
 `nbsphinx`_ has support for :doc:`creating thumbnail galleries from a list of Jupyter
 notebooks <nbsphinx:subdir/gallery>`.
-This functionality relies on `Sphinx-Gallery <https://sphinx-gallery.github.io/>`_
-and extends it to work with Jupyter notebooks rather than Python scripts.
 
-To use it, you will need to install both nbsphinx and Sphinx-Gallery,
-and modify your ``conf.py`` as follows:
-
-.. code-block:: python
-   :caption: conf.py
-
-   extensions = [
-       "nbsphinx",
-       "sphinx_gallery.load_style",
-   ]
-
-After doing that, there are two ways to create the gallery:
+There are two ways to create the gallery:
 
 - From a reStructuredText source file, using the ``.. nbgallery::`` directive,
   :ref:`as showcased in the
@@ -266,9 +253,7 @@ After doing that, there are two ways to create the gallery:
 
    Panel to modify cell metadata in JupyterLab
 
-For example, this reST markup would create a thumbnail gallery
-with generic images as thumbnails,
-thanks to the Sphinx-Gallery default style:
+For example, this markup would create a thumbnail gallery:
 
 .. tabs::
 

docs/user/guides/jupyter.rst

@@ -31,30 +31,30 @@ The language will be represented in the URL for your project.
 For example,
 a project that is in Spanish will have a default URL of ``/es/latest/`` instead of ``/en/latest/``.
 
-Projects with multiple translations (Sphinx-only)
--------------------------------------------------
+Projects with multiple translations
+-----------------------------------
 
 .. seealso::
 
    :doc:`guides/manage-translations-sphinx`
-     Describes the whole process for a documentation with multiples languages in the same repository and how to keep the translations updated on time.
+     Describes the whole process for a Sphinx documentation projects with multiples languages
+     in the same repository and how to keep the translations updated on time.
 
-This situation is a bit more complicated.
-To support this,
-you will have one parent project and a number of projects marked as translations of that parent.
-Let's use ``phpmyadmin`` as an example.
+Each language must have its own project on Read the Docs.
+You will choose one to be the parent project,
+and add each of the other projects as "Translations" of the parent project.
 
-The main ``phpmyadmin`` project is the parent for all translations.
-Then you must create a project for each translation,
-for example ``phpmyadmin-spanish``.
-You will set the *Language* for ``phpmyadmin-spanish`` to ``Spanish``.
-In the parent projects *Translations* page,
-you will say that ``phpmyadmin-spanish`` is a translation for your project.
+Let's use ``godot`` as an example.
+
+The ``godot`` project is the parent.
+Each translation then has its own project, for example ``godot-es``.
+The *Language* for ``godot-es`` is set to ``Spanish``.
+Then, on the  *Translations* page of the ``godot`` project, ``godot-es`` is set as translation.
 
 This has the results of serving:
 
-* ``phpmyadmin`` at ``http://phpmyadmin.readthedocs.io/en/latest/``
-* ``phpmyadmin-spanish`` at ``http://phpmyadmin.readthedocs.io/es/latest/``
+* ``godot`` at ``https://docs.godotengine.org/en/stable/``
+* ``godot-es`` at ``https://docs.godotengine.org/es/stable/``
 
 It also gets included in the Read the Docs :term:`flyout menu`:
 
@@ -65,12 +65,6 @@ It also gets included in the Read the Docs :term:`flyout menu`:
     parent project that the domain was configured on. See
     :doc:`/custom-domains` for more information.
 
-.. note:: You can include multiple translations in the same repository,
-          with same ``conf.py`` and ``.rst`` files,
-          but each project must specify the language to build for those docs.
-
-.. note:: You must commit the ``.po`` files for Read the Docs to translate your documentation.
-
 
 Translation workflows
 ~~~~~~~~~~~~~~~~~~~~~
@@ -80,23 +74,20 @@ the workflow of your translators becomes a critical component.
 
 Considerations include:
 
-* Are your translators able to use a git workflow? For instance, are they able to translate directly via GitHub?
+* Are your translators able to use a Git workflow? For instance, are they able to translate directly via GitHub?
 * Do you benefit from machine translation?
 * Do you need different roles, for instance do you need translators and editors?
 * What is your source language?
 * When are your translated versions published?
 
-By using Sphinx and .po files,
-you will be able to automatically synchronize between your documentation source messages on your git platform and your translation platform.
-
 There are many translation platforms that support this workflow.
 These include:
 
 * `Weblate <https://weblate.org/>`_
 * `Transifex <https://www.transifex.com/>`_
 * `Crowdin <https://crowdin.com/>`_
 
-Because Read the Docs builds your git repository,
+Because Read the Docs builds your Git repository,
 you can use any of the above solutions.
-Any solution that synchronizes your translations with your git repository
+Any solution that synchronizes your translations with your Git repository
 will ensure that your translations are automatically published with Read the Docs.

docs/user/img/translation_bar.png

@@ -1,6 +1,6 @@
 {
   "name": "readthedocs",
-  "version": "11.5.0",
+  "version": "11.6.0",
   "description": "Read the Docs build dependencies",
   "author": "Read the Docs, Inc <[email protected]>",
   "scripts": {

docs/user/localization.rst

@@ -1,4 +1,4 @@
 """Read the Docs."""
 
 
-__version__ = "11.5.0"
+__version__ = "11.6.0"

package.json

@@ -67,7 +67,7 @@ def send_invitation(self):
         )
         send_email(
             recipient=email,
-            subject=f"{from_name} has invite you to join the {object_description}",
+            subject=f"{from_name} has invited you to join the {object_description}",
             template="invitations/email/invitation.txt",
             template_html="invitations/email/invitation.html",
             context={

readthedocs/__init__.py

@@ -1,5 +1,3 @@
-import textwrap
-
 import structlog
 from django.contrib.contenttypes.fields import GenericForeignKey
 from django.contrib.contenttypes.models import ContentType
@@ -8,8 +6,8 @@
 from django.utils.translation import gettext_noop as _
 from django_extensions.db.models import TimeStampedModel
 
-from .constants import CANCELLED, DISMISSED, READ, UNREAD, WARNING
-from .messages import Message, registry
+from .constants import CANCELLED, DISMISSED, READ, UNREAD
+from .messages import registry
 from .querysets import NotificationQuerySet
 
 log = structlog.get_logger(__name__)
@@ -76,24 +74,11 @@ def get_message(self):
 
         message = registry.get(self.message_id, format_values=format_values)
         if message is None:
-            # Log the error and return an unknown error to avoid breaking the response.
+            # Log the error and let the None message return through the API
             log.error(
                 "The message ID retrieved is not in our registry anymore.",
                 message_id=self.message_id,
             )
-            return Message(
-                id="unknown-message",
-                header=_("Unknown message"),
-                body=_(
-                    textwrap.dedent(
-                        """
-                        It seems it was an old message,
-                        and is not in our registry anymore.
-                        """
-                    ).strip(),
-                ),
-                type=WARNING,
-            )
 
         return message
 

readthedocs/invitations/backends.py

@@ -229,6 +229,7 @@ def subscription_canceled(event):
         except SSOIntegration.DoesNotExist:
             sso_integration = "Read the Docs Auth"
 
+        # https://api.slack.com/surfaces/messages#payloads
         slack_message = {
             "blocks": [
                 {
@@ -241,19 +242,11 @@ def subscription_canceled(event):
                     "fields": [
                         {
                             "type": "mrkdwn",
-                            "text": f":office: *Name:* {organization.name}",
+                            "text": f":office: *Name:* <{settings.ADMIN_URL}/organizations/organization/{organization.pk}/change/|{organization.name}>",
                         },
                         {
                             "type": "mrkdwn",
-                            "text": f":dollar: *Plan:* {stripe_subscription.plan.id}",
-                        },
-                        {
-                            "type": "mrkdwn",
-                            "text": f":hash: *Slug:* {organization.slug}",
-                        },
-                        {
-                            "type": "mrkdwn",
-                            "text": f":person_frowning: *Stripe customer:* <https://dashboard.stripe.com/customers/{stripe_subscription.customer_id}|{stripe_subscription.customer_id}>",
+                            "text": f":dollar: *Plan:* <https://dashboard.stripe.com/customers/{stripe_subscription.customer_id}|{stripe_subscription.plan.product.name}> (${str(total_spent)})",
                         },
                         {
                             "type": "mrkdwn",
@@ -286,11 +279,14 @@ def subscription_canceled(event):
             ]
         }
         try:
-            requests.post(
+            response = requests.post(
                 settings.SLACK_WEBHOOK_SALES_CHANNEL,
-                data=slack_message,
+                json=slack_message,
                 timeout=3,
             )
+            if not response.ok:
+                log.error("There was an issue when sending a message to Slack webhook")
+
         except requests.Timeout:
             log.warning("Timeout sending a message to Slack webhook")
 

readthedocs/notifications/models.py

@@ -71,6 +71,15 @@ <h3>{% trans 'Or' %}</h3>
   <div class="clearfix">
     <ul class="socialaccount_providers">
       {% include "socialaccount/snippets/provider_list.html" with process="login" next=request.GET.next verbiage="Log in using" %}
+      {% if USE_ORGANIZATIONS %}
+      <li>
+        <form action="{% url "saml_resolve_login" %}{% if redirect_field_value %}?{{ redirect_field_name }}={{ redirect_field_value }}{% endif %}" method="get">
+          <button class="socialaccount-provider button" type="submit">
+              {% trans "Log in using single sign-on" %}
+          </button>
+        </form>
+      </li>
+      {% endif %}
     </ul>
   </div>
 {% endif %}

readthedocs/subscriptions/event_handlers.py

@@ -1,6 +1,6 @@
 [metadata]
 name = readthedocs
-version = 11.5.0
+version = 11.6.0
 license = MIT
 description = Read the Docs builds and hosts documentation
 author = Read the Docs, Inc
@@ -29,7 +29,7 @@ github_owner = readthedocs
 github_repo = readthedocs.org
 
 [bumpver]
-current_version = "11.5.0"
+current_version = "11.6.0"
 version_pattern = "MAJOR.MINOR.PATCH[TAGNUM]"
 commit_message = "Bump version {old_version} -> {new_version}"
 commit = False