[GH-3033] [DOCS] Fix Whimsy site-check failures: ASF footer links, nav URLs, and external GitHub API call (GH-3033) - #3060
Merged
Conversation
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.
Contributor
There was a problem hiding this comment.
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.ymlby removing straytarget="_blankfragments. - 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.htmlpartial 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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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:
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 asnav:entries inmkdocs.ymland never rendered in the footer.mkdocs.yml— Removes the stray" target="_blankthat had been appended to the License, Events, Sponsorship, Thanks, Security, and Privacy nav URLs, which produced malformed hrefs.docs-overrides/partials/source.html(new) — Overrides the Material for MkDocs source partial to render the repo link withoutdata-md-component="source", so the theme no longer fetches stars/forks/version fromapi.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?
Is this PR related to a ticket?
[GH-XXX] my subject. Closes Apache Sedona Website Check: Checking ASF Project Websites for required and disallowed content #3033