Skip to content

[#236] Remove unused canonical front matter from release posts - #243

Merged
vharseko merged 1 commit into
OpenIdentityPlatform:masterfrom
vharseko:drop-unused-canonical
Oct 1, 2026
Merged

vharseko merged 1 commit into
OpenIdentityPlatform:masterfrom
vharseko:drop-unused-canonical

Conversation

@vharseko

Copy link
Copy Markdown
Member

Summary

33 release-note posts declared canonical: pointing at the GitHub release page (OpenAM 11, OpenIDM 10, OpenICF 5, OpenDJ 4, OpenIG 3), but nothing reads it: _includes/header.html always emits the post's own URL as <link rel="canonical">.

This PR takes the first option from #236: keep the site's own release notes canonical (the current behaviour) and remove the dead field, so nobody editing a post assumes it controls the canonical link. Making header.html honour page.canonical instead would hand search ranking for these pages to GitHub.

Fixes #236

Verification

  • The diff is exactly 33 removed canonical: lines, nothing else.
  • Every one of the 33 posts already links to its GitHub release in the body, so no link is lost.
  • Nothing else consumes the field: in a built site the post's rel="canonical" is its own URL, feed.xml has no canonical, and no page declares a github.com URL as canonical. The rendered output is unchanged.

header.html always emits the post's own URL as rel="canonical", so the
canonical: field pointing at the GitHub release page was never used.
Keep the site's release notes canonical and drop the dead field from
the 33 posts; each post already links to its GitHub release in the body.

Fixes OpenIdentityPlatform#236
@vharseko vharseko added the enhancement New feature or request label Sep 30, 2026
@vharseko vharseko added the question Further information is requested label Sep 30, 2026

@maximthomas maximthomas 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.

praise: The change removes exactly the dead field and nothing else.

  • The diff is 33 -canonical: lines in 33 _posts/*.md files, no other line, and every removed GitHub release URL still appears verbatim in its post body.
  • _includes/header.html:37 builds rel="canonical" from og_url (site.url + page.url, :3), and nothing at this head reads page.canonical: not the layouts, not jekyll-feed, not GitHub Pages' default plugins. The rendered output is unchanged.

@vharseko
vharseko merged commit 4743197 into OpenIdentityPlatform:master Oct 1, 2026
1 check passed
@vharseko
vharseko deleted the drop-unused-canonical branch October 1, 2026 15:22
vharseko added a commit that referenced this pull request Oct 1, 2026
## Summary

Six OpenIDM posts reference `imageurl: 'openidm-og.png'`, but
`assets/img/openidm-og.png` did not exist, so their `og:image`,
`twitter:image` and `BlogPosting` JSON-LD `image` pointed to a 404:

- `_posts/2024-09-10-openidm-ad-idm.md`
- `_posts/2024-11-13-openidm-can-your-idm-play-chess.md`
- `_posts/2025-05-13-openidm-two-way-ad-opendj.md`
- `_posts/2025-07-16-openidm-6-3-0-released.md`
- `_posts/2025-11-05-openidm-getting-started.md`
- `_posts/2026-02-05-openidm-7-0-2-released.md`

This PR adds the image, generated from `openidm-logo.png` in the same
format as `openam-og.png`, `opendj-og.png` and `openig-og.png`: 1024×512
RGBA, opaque white background, the logo scaled to 921 px wide and
centered (content box x 52–972, centre 512, 255.5 — the same as the
other three). No post or template changes are needed for these six
posts.

It also adds `assets/img/openicf-og.png`, the nice-to-have from the
issue, generated the same way from `openicf-logo.png`, and points all 13
OpenICF posts at it: 10 used the bare `openicf-logo.png`, and 3
(`1.8.0`, `2.0.1`, `2.0.3`) had no `imageurl` and fell back to the
GitHub avatar.

The empty `imageurl: ''` from the issue is fixed in #239.

Fixes #232

## Verification

Built the site with `bundle exec jekyll build` (Ruby 3.1, as in CI) and
ran the workflow's `htmlproofer` internal-link check: no errors. OpenIDM
posts render `og:image` / JSON-LD `image` as
`…/assets/img/openidm-og.png`, OpenICF posts as
`…/assets/img/openicf-og.png`; no rendered page references
`openicf-logo.png` as its image any more. This branch merges cleanly
with #239–#243 (checked with `git merge-tree`), including #243, which
removes `canonical:` two lines below in the same OpenICF posts.

## Preview


![openidm-og.png](https://raw.githubusercontent.com/vharseko/OpenIdentityPlatform.org/openidm-og-image/assets/img/openidm-og.png)


![openicf-og.png](https://raw.githubusercontent.com/vharseko/OpenIdentityPlatform.org/openidm-og-image/assets/img/openicf-og.png)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request question Further information is requested

Projects

None yet

Development

Successfully merging this pull request may close these issues.

canonical front matter in 33 posts is ignored by the header template

2 participants