andygrove opened a new pull request, #6245:
URL: https://github.com/apache/datafusion-comet/pull/6245

   ## Which issue does this PR close?
   
   No issue; this is documentation only. It follows up on #4851. #4854 fixed 
that by correcting the URL in Comet's fallback messages, but releases before 
the fix still print the old URL, and this fixes where that URL leads.
   
   ## Rationale for this change
   
   Two of the redirects in `docs/source/conf.py` lead to pages that don't exist.
   
   `user-guide/compatibility.html` redirects to `latest/compatibility.html`, 
but #4055 split the compatibility guide into a directory of pages, so that page 
is gone and the redirect ends in a 404. Comet 0.13 through 0.17 print 
`https://datafusion.apache.org/comet/user-guide/compatibility.html` in their 
fallback messages, so users of those releases who follow the link from an 
explain plan hit the 404. `latest/compatibility.html` itself is also still 
linked from older issues such as #2743 and #3825.
   
   The data sources entry is spelled `user-guide/datasource.html` to 
`latest/datasource.html`, and neither page has ever existed; the page is 
`datasources`. #2324 replaced a stub page at `user-guide/datasources.md` with 
this entry, so the page's real old URL, `user-guide/datasources.html`, has had 
no redirect since then.
   
   ## What changes are included in this PR?
   
   - `user-guide/compatibility.html` now redirects to 
`latest/compatibility/index.html`.
   - A new redirect from `user-guide/latest/compatibility.html` to 
`compatibility/index.html`.
   - The `user-guide/datasource.html` entry becomes 
`user-guide/datasources.html`, redirecting to `latest/datasources.html`.
   
   ## How are these changes tested?
   
   Documentation only, no code paths touched.
   
   I built the site locally with Sphinx and checked every entry in `redirects`: 
each redirect page is written and its target exists in the built site. Before 
this change, the two entries above were the only ones whose target was missing. 
I also loaded the three changed redirects in headless Chrome, and each ends on 
the right page, the Compatibility Guide or Supported Spark Data Sources. The 
build adds no warnings.
   


-- 
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