-
Notifications
You must be signed in to change notification settings - Fork 36
Make the RSS-feed fulltext #75
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
This copies the default rss template from zola and changes the <description> tag of all pages from page.summary to page.content to show the whole article in rss readers and not only the summary (which, in case of the newsletter, only explains the concept of the newsletter and shows links to the discussion, but does not summarize this specific newsletter itself)
Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @andre-richter (or someone else) soon. If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes. Please see the contribution instructions for more information. |
I checked the rendering in Feeder and It looks fine. The tables are not rendered at all, it just displays the table as one line per cell, as if it would just ignore all table-related html tags. It's readable and understandable, but not really pretty, but in my opinion, this is an acceptable tradeoff. Of course, other rss-readers can render this differently. |
@rust-embedded/resources anybody feels like taking the review token here? Description reads good, but then I have zero history maintaining the blog infra... |
@andre-richter This is really just configuration. It looks good to me but I really can't properly test it. We could simply apply it, try it out with the real feed once deployed and back it out in case it's not improvement. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
SGTM, let's merge and see if we get any complaints :)
bors r+
75: Make the RSS-feed fulltext r=jamesmunns a=mqus This copies the [default rss template from zola](https://github.com/getzola/zola/blob/master/components/templates/src/builtins/rss.xml) and changes the `<description>` tag of all pages from `page.summary` to `page.content` to show the whole article in rss readers and not only the summary (which, in case of the newsletter, only explains the concept of the newsletter and shows links to the discussion, but does not summarize this specific newsletter itself, which I find pretty useless). For comparison, This Week in Rust also puts the fulltext articles in the rss-feed. I have tried the change locally and it does generate the intended `rss.xml`, but I didn't check if it also renders as nice as intended (But I'm pretty sure it will, I'll test this soon.) I'm also not sure how smooth the transition between these two rss feeds has to be. Co-authored-by: Markus Richter <8398165+mqus@users.noreply.github.com>
Build succeeded |
Thanks! |
It doesn't seem to propagate to the site... |
@mqus what version of Zola are you using locally? Maybe we need to update the version in CI? |
0.9.0, but according to the changelog of zola (https://github.com/getzola/zola/blob/master/CHANGELOG.md) there weren't any relevant changes in recent releases... I'll test it again as soon as I can and try to look into it. |
I downgraded zola to 0.5.1 (which should be the version the ci uses) and it creates the rss.xml just like the ci and differently than 0.9.0. so it seems I was wrong and It is a version issue... I'll see if I can get it to work in 0.5.1 |
You can also send a PR to update CI to 0.9.0, no objections here, thanks again for following up with this! |
I'd rather not update CI, as it does seem to break some subtle things (such as rss) and I'm not that involved with zola or the rust embedded blog, but if you do the step in the future I'll match the rss file. |
86: Fix rss template r=jamesmunns a=mqus This commit fixes the rss fulltext template introduced in #75 which was originally build under the assumption of zola v0.9.0. For v0.5.1 the template has to be in a different location and can't use `escape_xml` as that was introduced in later versions. This should do no harm because the links didn't contain xml in the first place. Co-authored-by: Markus Richter <8398165+mqus@users.noreply.github.com>
This copies the default rss template from zola and changes the
<description>
tag of all pages frompage.summary
topage.content
to show the whole article in rss readers and not only the summary (which, in case of the newsletter, only explains the concept of the newsletter and shows links to the discussion, but does not summarize this specific newsletter itself, which I find pretty useless). For comparison, This Week in Rust also puts the fulltext articles in the rss-feed.I have tried the change locally and it does generate the intended
rss.xml
,but I didn't check if it also renders as nice as intended (But I'm pretty sure it will, I'll test this soon.)
I'm also not sure how smooth the transition between these two rss feeds has to be.