From c133e52db4ed55fadc125a5a0b78fa11276afb5f Mon Sep 17 00:00:00 2001 From: Philipp Kitzberger Date: Mon, 27 May 2024 11:56:19 +0200 Subject: [PATCH] [DOCS] Mention XML sitemap configuration (#735) --- Documentation/Configuration/XmlSitemap.rst | 24 ++++++++++++++++++++++ Documentation/Index.rst | 1 + 2 files changed, 25 insertions(+) create mode 100644 Documentation/Configuration/XmlSitemap.rst diff --git a/Documentation/Configuration/XmlSitemap.rst b/Documentation/Configuration/XmlSitemap.rst new file mode 100644 index 00000000..d7c6e79f --- /dev/null +++ b/Documentation/Configuration/XmlSitemap.rst @@ -0,0 +1,24 @@ +.. _xmlsitemap: + +=================== +XML Sitemap +=================== + +Since `ext:headless` 4.0 there's no custom code regarding the XML sitemaps +apart from the templates used to render the XML sitemap's source code. + +Troubleshooting +=============== + +In case the URLs listed in the "sitemap index" file (usually `/sitemap.xml`) +aren't "frontend URLs" (but their API variant), consider setting one of the two +following configurations: + +* either `frontendApiProxy` being defined in the site's `config.yaml` +* or this in the site's `settings.yaml`: + +.. code-block:: yaml + + headless: + sitemap: + key: frontendBase diff --git a/Documentation/Index.rst b/Documentation/Index.rst index daea662f..2ca10b4a 100644 --- a/Documentation/Index.rst +++ b/Documentation/Index.rst @@ -72,6 +72,7 @@ or `report a problem ` Installation/Index Configuration/Index Configuration/Preview + Configuration/XmlSitemap Developer/Index Developer/Images FAQ/Index