Skip to content

Site: Add description field to blog posts for RSS feed#15327

Closed
kevinjqliu wants to merge 1 commit intoapache:mainfrom
kevinjqliu:kevinjqliu/fix-blog-rss-description
Closed

Site: Add description field to blog posts for RSS feed#15327
kevinjqliu wants to merge 1 commit intoapache:mainfrom
kevinjqliu:kevinjqliu/fix-blog-rss-description

Conversation

@kevinjqliu
Copy link
Contributor

Add explicit description fields to blog post to improve RSS feed quality.

The mkdocs-rss-plugin was rendering HTML comments (including the ASF license header) in the RSS feed description. By adding an explicit description field to each blog post's front matter, the plugin uses that instead of parsing the page content.

Before

Screenshot 2026-02-15 at 7 22 37 AM

After

Screenshot 2026-02-15 at 7 28 30 AM

@kevinjqliu
Copy link
Contributor Author

@manuzhang i saw your upstream fix (Guts/mkdocs-rss-plugin#421)
claude suggested this as a workaround. ptal

@kevinjqliu kevinjqliu added the website Style-issues related to the Iceberg website label Feb 15, 2026
@manuzhang
Copy link
Member

@kevinjqliu I don't see an issue currently. What will be it like in a RSS reader after this change?

CleanShot 2026-02-16 at 14 25 36@2x

@kevinjqliu
Copy link
Contributor Author

@manuzhang I think most rss readers strip out the html comment before displaying the content; i noticed the same
thing in the slack integration.

The only difference here is the raw html string. Right now, in https://iceberg.apache.org/rss.xml, the <description> field contains the html comment.

Maybe we should just let the description to be auto-generated (w/ the html comment), looks like most readers will display it properly.; and we dont expect humans to read https://iceberg.apache.org/rss.xml directly

@kevinjqliu
Copy link
Contributor Author

Closing since readers display the description correctly. Thanks Manu!

@kevinjqliu kevinjqliu closed this Feb 16, 2026
@kevinjqliu kevinjqliu deleted the kevinjqliu/fix-blog-rss-description branch February 16, 2026 14:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs website Style-issues related to the Iceberg website

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants