alamb opened a new pull request, #26827:
URL: https://github.com/apache/datafusion/pull/26827

   ## Which issue does this PR close?
   
   - Part of #17071
   - Follow on to #24792, see 
https://github.com/apache/datafusion/pull/24792#issuecomment-6446457683
   
   ## Rationale for this change
   
   Release documentation published under `/versions/<version>/` is built with 
the overlay in `docs/scripts/release/conf.py`, which sets `html_baseurl` to the 
versioned prefix. Sphinx uses that setting to emit a `<link rel="canonical">` 
tag on every page, so today each versioned copy of a page declares itself 
canonical and competes in search results with the development docs at the site 
root (for example, compare 
https://datafusion.apache.org/user-guide/configs.html and 
https://datafusion.apache.org/versions/55.1.0/user-guide/configs.html). Each 
versioned tree also ships its own `sitemap.xml`.
   
   Only the development documentation at the site root should be indexed by 
search engines.
   
   ## What changes are included in this PR?
   
   - Clear `html_baseurl` in the release overlay so release builds emit no 
`<link rel="canonical">` tag
   - Drop `sphinx_sitemap` from release builds so no per-version `sitemap.xml` 
is written (the extension requires `html_baseurl`, and the root `robots.txt` 
only references the root sitemap anyway)
   - Remove the now unnecessary `--with sphinx-sitemap` note from the release 
instructions
   
   The already published trees for 55.0.0 and 55.1.0 keep their current tags 
until they are rebuilt with the overlay.
   
   ## Are these changes tested?
   
   Built the `55.1.0` tag with the modified overlay (`sphinx-build -c 
docs/scripts/release`) and confirmed the output has no `rel="canonical"` link 
on any page, no `sitemap.xml`, and still has the version switcher configured 
with `version_match` of `55.1.0`.
   
   ## Are there any user-facing changes?
   
   No. The rendered documentation looks the same; only the `<head>` metadata 
and the generated sitemap of versioned builds change.
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]


---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to