Skip to content

[GH-3033] [DOCS] Fix Whimsy site-check failures: ASF footer links, nav URLs, and external GitHub API call (GH-3033) - #3060

Merged
jiayuasu merged 3 commits into
masterfrom
fix-whimsy-site-checks-3033
Jun 19, 2026
Merged

[GH-3033] [DOCS] Fix Whimsy site-check failures: ASF footer links, nav URLs, and external GitHub API call (GH-3033)#3060
jiayuasu merged 3 commits into
masterfrom
fix-whimsy-site-checks-3033

Conversation

@jiayuasu

Copy link
Copy Markdown
Member

What this PR does

Fixes the Whimsy project website checks for Sedona (https://whimsy.apache.org/site/project/sedona), which were failing nearly every required-content check. Three changes:

  1. docs-overrides/partials/copyright.html — Adds the ASF-required links to the rendered site footer so they appear on the homepage where Whimsy looks: License, Events, Sponsorship, Thanks, Security, Privacy, and Trademarks. Also makes the copyright notice itself a link (Whimsy's Copyright check expects a link matching (©|Copyright).*apache). Previously these links only existed as nav: entries in mkdocs.yml and never rendered in the footer.

  2. mkdocs.yml — Removes the stray " target="_blank that had been appended to the License, Events, Sponsorship, Thanks, Security, and Privacy nav URLs, which produced malformed hrefs.

  3. docs-overrides/partials/source.html (new) — Overrides the Material for MkDocs source partial to render the repo link without data-md-component="source", so the theme no longer fetches stars/forks/version from api.github.com. Those calls were being refused by the site CSP and showed up as failed external resources in the Whimsy "Resources" check. The ASF-sanctioned Scarf and Matomo pixels are unaffected.

Did you read the Contributor Guide?

  • Yes.

Is this PR related to a ticket?

jiayuasu added 3 commits June 19, 2026 00:08
Adds the ASF-required navigation links (License, Events, Sponsorship, Thanks, Security, Privacy, Trademarks) and a linked copyright notice to the rendered site footer so they appear on the homepage. Addresses part of the Whimsy site-check failures reported in GH-3033.
Removes the stray `" target="_blank` appended to the License, Events, Sponsorship, Thanks, Security, and Privacy nav URLs, which produced malformed hrefs. Part of GH-3033.
Overrides the Material theme's source partial to render the repo link without `data-md-component="source"`, so the theme no longer fetches stars/forks/version from api.github.com. This removes the blocked external resource requests flagged by the Whimsy site check (CSP refuses api.github.com). Part of GH-3033.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates the MkDocs configuration and theme overrides for the Sedona project website to satisfy Apache Whimsy required-content checks and to avoid blocked external GitHub API requests during site rendering.

Changes:

  • Fix malformed ASF navigation URLs in mkdocs.yml by removing stray target="_blank fragments.
  • Update the footer partial to render ASF-required links (License, Events, Sponsorship, Thanks, Security, Privacy, Trademarks) and a Whimsy-detectable copyright link.
  • Add a Material for MkDocs source.html partial override to render the repository link without triggering GitHub API metadata fetching.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.

File Description
mkdocs.yml Cleans up malformed external ASF nav URLs so generated hrefs are valid.
docs-overrides/partials/source.html Overrides the theme “source” partial to render the repo link without the GitHub API metadata component.
docs-overrides/partials/copyright.html Adds ASF-required footer links and adjusts copyright rendering for Whimsy checks.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@jiayuasu jiayuasu added this to the sedona-1.9.1 milestone Jun 19, 2026
@jiayuasu
jiayuasu merged commit b9e1767 into master Jun 19, 2026
12 checks passed
jiayuasu added a commit that referenced this pull request Jun 19, 2026
@jiayuasu
jiayuasu deleted the fix-whimsy-site-checks-3033 branch June 26, 2026 00:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Apache Sedona Website Check: Checking ASF Project Websites for required and disallowed content

2 participants