jiayuasu opened a new pull request, #3065:
URL: https://github.com/apache/sedona/pull/3065

   ## Is this PR related to a ticket?
   
   Yes. Closes #3033 (partially — see below).
   
   ## What changes were proposed in this PR?
   
   This addresses the remaining red link-checks in the [Whimsy site 
report](https://whimsy.apache.org/site/project/sedona) for the ASF-required 
footer links (License, Events, Sponsorship, Thanks, Security, Privacy, 
Trademarks).
   
   ### Background / root cause
   
   The deployed footer on the actual docs pages (e.g. `/latest/`) already 
contains all required links. However, Whimsy crawls the bare site root 
`https://sedona.apache.org/`, which is the `mike`-generated redirect stub. That 
stub is a client-side `window.location.replace(...)` (plus a `<noscript>` 
meta-refresh) and contains none of the footer links. Whimsy does not execute 
JavaScript and does not follow the client-side redirect, so it reads the stub 
and reports the links as missing.
   
   ### Changes
   
   1. **`docs-overrides/redirect.html`** — a custom `mike` redirect template. 
It keeps the existing redirect behaviour (canonical link, `<noscript>` 
meta-refresh, and JS `location.replace`) so real users are still sent to `{{ 
href }}` instantly, and adds a `<footer>` containing the ASF-required links so 
crawlers see them at the root.
   2. **`.github/workflows/docs.yml`** — adds a `mike set-default latest -T 
docs-overrides/redirect.html` step after the release deploy, so the root 
redirect is regenerated from the new template. The workflow previously never 
ran `set-default`, which is why the root stub had not been regenerated since 
2023.
   
   ### Notes
   
   - These footer links are not shown to human visitors (they are redirected 
away immediately); they exist so the site root exposes the ASF-required links 
to crawlers such as Whimsy.
   - The root is only regenerated on release branch (`branch-*`) deploys, since 
that is when the `latest` alias is updated. The Whimsy report will therefore go 
green after the next release deploy rather than immediately.
   
   ## How was this patch tested?
   
   Template rendering reviewed manually; redirect logic and link set verified 
against the existing root stub and the `mike set-default --template` contract 
(`{{ href }}` substitution).
   
   ## Did you read the Contributor Guide?
   
   Yes — [Contributor Rules](https://sedona.apache.org/latest/community/rule/) 
and [Contributor Development 
Guide](https://sedona.apache.org/latest/community/develop/).


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

Reply via email to