Skip to content

Improve page summaries and the news page

Coffee requested to merge Matrixcoffee/fdroid-website:coffee/improve_summaries into master

This is a proposal to change how summaries are generated from content.

The purpose is to improve the News page (https://f-droid.org/news/ et al.) by honoring the cutmarks I've been adding to recent TWIFs. This prevents additional cruft from being added after the summary.

  • For the /news/ page, use the jekyll summary instead of the whole page to generate descriptions. This allows the cutmark to work.
  • Globally set a custom cutmark (<!--more-->) that separates the summary at the top from content below, on every page.

A secondary goal is to improve summaries site-wide. Some meta summaries become crufty, but it also adds summaries where there were none before. I think in the balance, this is an improvement, and there are no things breaking badly. Where things do get slightly worse, these can be improved individually by placing a cutmark or providing an explicit summary in the jekyll front matter.

This is only a very small diff, but it touches the entire website, so careful scrutiny is required. Accordingly, I set up the MR to be approved by at least 2 people before merging.

To help understand the impact, I downloaded the "before" and "after" build artifacts and prepared two diffs that hopefully accurately show the impact of this MR.

  • The non-i18n diff minimizes duplicates and should give a good impression of the changes.
  • The i18n diff includes the i18n directories for completeness.

If you prefer this MR squashed, please let me know so I can re-push it myself. If squashed in GitLab, it will add my real e-mail address.

Thank you for your consideration.

Edited by Coffee

Merge request reports