Site: Add description field to blog posts for RSS feed#15327
Site: Add description field to blog posts for RSS feed#15327kevinjqliu wants to merge 1 commit intoapache:mainfrom
Conversation
|
@manuzhang i saw your upstream fix (Guts/mkdocs-rss-plugin#421) |
|
@kevinjqliu I don't see an issue currently. What will be it like in a RSS reader after this change?
|
|
@manuzhang I think most rss readers strip out the html comment before displaying the content; i noticed the same The only difference here is the raw html string. Right now, in https://iceberg.apache.org/rss.xml, the 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 |
|
Closing since readers display the description correctly. Thanks Manu! |

Add explicit
descriptionfields 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
descriptionfield to each blog post's front matter, the plugin uses that instead of parsing the page content.Before
After