Add documentation for content_handler

closes #6570
pulp · Apr 30, 2020 · 6563722 · 6563722
1 parent a0fce1f
commit 6563722
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 0 deletions.
diff --git a/CHANGES/plugin_api/6570.feature b/CHANGES/plugin_api/6570.feature
@@ -0,0 +1 @@
+Added support for Distributions to provide non-Artifact content via a content_handler.
diff --git a/CHANGES/plugin_api/6570.removal b/CHANGES/plugin_api/6570.removal
@@ -0,0 +1 @@
+The :meth:`pulpcore.content.handler.Handler.list_directory` function now returns a set of strings where it returned a string of HTML before.
diff --git a/docs/plugins/api-reference/content-app.rst b/docs/plugins/api-reference/content-app.rst
@@ -14,6 +14,10 @@ Making a custom Handler is a two-step process:
 2. Add the Handler to a route using aiohttp.server's `add_route() <https://aiohttp.readthedocs.io/en
    /stable/web_reference.html#aiohttp.web.UrlDispatcher.add_route>`_ interface.
 
+If content needs to be served from within the :term:`Distribution`'s base_path,
+overriding the :meth:`~pulpcore.plugin.models.BaseDistribution.content_handler` and
+:meth:`~pulpcore.plugin.models.BaseDistribution.content_handler_directory_listing`
+methods in your Distribution is an easier way to serve this content.
 
 Creating your Handler
 ---------------------