Added support for searching ecosystem and blog entries.

The blog results should have a property of whether it is included in
the search results.

* Added is_searchable.
* Used Entry.get_absolute_url to encapsulate www host.
* Extracted get_search_config helper function.

Co-authored-by: Baptiste Mispelon <bmispelon@gmail.com>

Author: tim-schilling

blog/admin.py

@@ -11,8 +11,15 @@
 
 @admin.register(Entry)
 class EntryAdmin(admin.ModelAdmin):
-    list_display = ("headline", "pub_date", "is_active", "is_published", "author")
-    list_filter = ("is_active",)
+    list_display = (
+        "headline",
+        "pub_date",
+        "is_active",
+        "is_published",
+        "is_searchable",
+        "author",
+    )
+    list_filter = ("is_active", "is_searchable")
     exclude = ("summary_html", "body_html")
     prepopulated_fields = {"slug": ("headline",)}
     raw_id_fields = ["social_media_card"]

blog/migrations/0006_entry_is_searchable.py

@@ -0,0 +1,21 @@
+# Generated by Django 5.2 on 2025-09-03 20:02
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("blog", "0005_entry_social_media_card"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="entry",
+            name="is_searchable",
+            field=models.BooleanField(
+                default=False,
+                help_text="Tick to make this entry appear in the Django documentation search.",
+            ),
+        ),
+    ]

blog/models.py

@@ -37,6 +37,9 @@ def published(self):
     def active(self):
         return self.filter(is_active=True)
 
+    def searchable(self):
+        return self.filter(is_searchable=True)
+
 
 class ContentFormat(models.TextChoices):
     REST = "reST", "reStructuredText"
@@ -126,6 +129,12 @@ class Entry(models.Model):
         ),
         default=False,
     )
+    is_searchable = models.BooleanField(
+        default=False,
+        help_text=_(
+            "Tick to make this entry appear in the Django documentation search."
+        ),
+    )
     pub_date = models.DateTimeField(
         verbose_name=_("Publication date"),
         help_text=_(
@@ -168,7 +177,7 @@ def get_absolute_url(self):
             "day": self.pub_date.strftime("%d").lower(),
             "slug": self.slug,
         }
-        return reverse("weblog:entry", kwargs=kwargs)
+        return reverse("weblog:entry", kwargs=kwargs, host="www")
 
     def is_published(self):
         """

blog/tests.py

@@ -68,6 +68,26 @@ def test_manager_published(self):
             transform=lambda entry: entry.headline,
         )
 
+    def test_manager_searchable(self):
+        """
+        Make sure that the Entry manager's `searchable` method works
+        """
+        Entry.objects.create(
+            pub_date=self.yesterday,
+            is_searchable=False,
+            headline="not searchable",
+            slug="a",
+        )
+        Entry.objects.create(
+            pub_date=self.yesterday, is_searchable=True, headline="searchable", slug="b"
+        )
+
+        self.assertQuerySetEqual(
+            Entry.objects.searchable(),
+            ["searchable"],
+            transform=lambda entry: entry.headline,
+        )
+
     def test_docutils_safe(self):
         """
         Make sure docutils' file inclusion directives are disabled by default.

docs/models.py

@@ -26,18 +26,26 @@
 from django.utils.html import strip_tags
 from django_hosts.resolvers import reverse
 
+from blog.models import Entry
 from releases.models import Release
 
 from . import utils
 from .search import (
     DEFAULT_TEXT_SEARCH_CONFIG,
+    SEARCHABLE_VIEWS,
     START_SEL,
     STOP_SEL,
     TSEARCH_CONFIG_LANGUAGES,
+    DocumentationCategory,
     get_document_search_vector,
 )
 
 
+def get_search_config(lang):
+    """Determine the PostgreSQL search language"""
+    return TSEARCH_CONFIG_LANGUAGES.get(lang[:2], DEFAULT_TEXT_SEARCH_CONFIG)
+
+
 class DocumentReleaseQuerySet(models.QuerySet):
     def current(self, lang="en"):
         current = self.get(is_default=True)
@@ -206,16 +214,84 @@ def sync_to_db(self, decoded_documents):
                 path=document_path,
                 title=html.unescape(strip_tags(document["title"])),
                 metadata=document,
-                config=TSEARCH_CONFIG_LANGUAGES.get(
-                    self.lang[:2], DEFAULT_TEXT_SEARCH_CONFIG
-                ),
+                config=get_search_config(self.lang),
             )
         for document in self.documents.all():
             document.metadata["breadcrumbs"] = list(
                 Document.objects.breadcrumbs(document).values("title", "path")
             )
             document.save(update_fields=("metadata",))
 
+        self._sync_blog_to_db()
+        self._sync_views_to_db()
+
+    def _sync_blog_to_db(self):
+        """
+        Sync the blog entries into search based on the release documents
+        support end date.
+        """
+        if self.lang != "en":
+            return  # The blog is only written in English currently
+
+        entries = Entry.objects.published().searchable()
+        Document.objects.bulk_create(
+            [
+                Document(
+                    release=self,
+                    path=entry.get_absolute_url(),
+                    title=entry.headline,
+                    metadata={
+                        "body": entry.body_html,
+                        "breadcrumbs": [
+                            {
+                                "path": DocumentationCategory.WEBSITE,
+                                "title": "News",
+                            },
+                        ],
+                        "parents": DocumentationCategory.WEBSITE,
+                        "slug": entry.slug,
+                        "title": entry.headline,
+                        "toc": "",
+                    },
+                    config=get_search_config(self.lang),
+                )
+                for entry in entries
+            ]
+        )
+
+    def _sync_views_to_db(self):
+        """
+        Sync the specific views into search based on the release documents
+        support end date.
+        """
+        if self.lang != "en":
+            return  # The searchable views are only written in English currently
+
+        Document.objects.bulk_create(
+            [
+                Document(
+                    release=self,
+                    path=searchable_view.www_absolute_url,
+                    title=searchable_view.page_title,
+                    metadata={
+                        "body": searchable_view.html,
+                        "breadcrumbs": [
+                            {
+                                "path": DocumentationCategory.WEBSITE,
+                                "title": "Website",
+                            },
+                        ],
+                        "parents": DocumentationCategory.WEBSITE,
+                        "slug": searchable_view.url_name,
+                        "title": searchable_view.page_title,
+                        "toc": "",
+                    },
+                    config=get_search_config(self.lang),
+                )
+                for searchable_view in SEARCHABLE_VIEWS
+            ]
+        )
+
 
 def _clean_document_path(path):
     # We have to be a bit careful to reverse-engineer the correct
@@ -228,7 +304,9 @@ def _clean_document_path(path):
 
 
 def document_url(doc):
-    if doc.path:
+    if doc.metadata.get("parents") == DocumentationCategory.WEBSITE:
+        return doc.path
+    elif doc.path:
         kwargs = {
             "lang": doc.release.lang,
             "version": doc.release.version,

docs/search.py

@@ -1,7 +1,11 @@
+from dataclasses import dataclass
+
 from django.contrib.postgres.search import SearchVector
 from django.db.models import TextChoices
 from django.db.models.fields.json import KeyTextTransform
+from django.template.loader import get_template
 from django.utils.translation import gettext_lazy as _
+from django_hosts import reverse
 
 # Imported from
 # https://github.com/postgres/postgres/blob/REL_14_STABLE/src/bin/initdb/initdb.c#L659
@@ -67,10 +71,35 @@ class DocumentationCategory(TextChoices):
     TOPICS = "topics", _("Using Django")
     HOWTO = "howto", _("How-to guides")
     RELEASE_NOTES = "releases", _("Release notes")
+    WEBSITE = "website", _("Django Website")
 
     @classmethod
     def parse(cls, value, default=None):
         try:
             return cls(value)
         except ValueError:
             return None
+
+
+@dataclass
+class SearchableView:
+    page_title: str
+    url_name: str
+    template: str
+
+    @property
+    def html(self):
+        return get_template(self.template).render()
+
+    @property
+    def www_absolute_url(self):
+        return reverse(self.url_name, host="www")
+
+
+SEARCHABLE_VIEWS = [
+    SearchableView(
+        page_title="Django's Ecosystem",
+        url_name="community-ecosystem",
+        template="aggregator/ecosystem.html",
+    ),
+]

docs/templates/docs/search_results.html

@@ -43,11 +43,11 @@ <h2>{% translate "No search query given" %}</h2>
         {% for result in page.object_list %}
           <dt>
             <h2 class="result-title">
-              <a href="{% url 'document-detail' lang=result.release.lang version=result.release.version url=result.path host 'docs' %}{% if not start_sel in result.headline %}{{ result.highlight|fragment }}{% endif %}">{{ result.headline|safe }}</a>
+              <a href="{{ result.get_absolute_url }}{% if not start_sel in result.headline %}{{ result.highlight|fragment }}{% endif %}">{{ result.headline|safe }}</a>
             </h2>
             <span class="meta breadcrumbs">
               {% for breadcrumb in result.breadcrumbs %}
-                <a href="{% url 'document-detail' lang=result.release.lang version=result.release.version url=breadcrumb.path host 'docs' %}">{{ breadcrumb.title }}</a>{% if not forloop.last %} <span class="arrow">»</span>{% endif %}
+                <a href="{{ result.get_absolute_url }}">{{ breadcrumb.title }}</a>{% if not forloop.last %} <span class="arrow">»</span>{% endif %}
               {% endfor %}
             </span>
           </dt>
@@ -60,7 +60,7 @@ <h2 class="result-title">
               <ul class="code-links">
                 {% for name, value in result_code_links.items %}
                   <li>
-                    <a href="{% url 'document-detail' lang=result.release.lang version=result.release.version url=result.path host 'docs' %}#{{ value.full_path }}">
+                    <a href="{{ result.get_absolute_url }}#{{ value.full_path }}">
                       <div>
                         <code>{{ name }}</code>
                         {% if value.module_path %}<div class="meta">{{ value.module_path }}</div>{% endif %}