RSS-Bridge / RSS-Bridge/rss-bridge

Bridge request: Web archive for Mailman instance

Open
#1,069 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Bridge-Request
Dominant language
PHP
Stars
9.2k
Forks
1.2k
Avg merge
12h 45m
Merged PRs (30d)
2

Description

Bridge request

As a heavy user of RSS-bridge, I would like to have an RSS feed generator that can parse the web-based archives of mailing lists implemented with GNU Mailman.

General information

Given a GNU Mailman powered mailing list such as the IETF Calsify list, I would like to plug the URL for the web archive (https://mailarchive.ietf.org/arch/browse/calsify/) into a field of RSS-bridge and get an RSS feed of posts sent to/through the mailing list.

The kind of information I would like to see generated by such a feed:

  • URL to a new post in the archive.

  • Subject line of a new post in the archive.

  • To and From lines of a new post in the archive.

  • Body of a new post in the archive.

  • Links to previous and next posts in the discussion thread (if present).

  • How should the information be displayed/formatted?

<item>
<title> [ subject line goes here ] </title>
<link>[ link to the post in the archive]</link>
<pubDate>[ date the message was sent] </pubDate>
<author>[ contents of From: line]</author>
<guid isPermaLink="true">[ URI to post in the archive ]</guid>
<description>
[ contents of From: line]
[ contents of To: line]
[ contents of Subject: line]
[ contents of date and time line]
[ body of message ]
[ link to previous post in thread, if applicable ]
[ link to next post in thread, if applicable ]
</description>
</item>
  • Title
  • URI (link to the original article)
  • Author
  • Timestamp
  • Content (the content of the article)
  • Enclosures (message attachments?)
  • Categories (categories, tags, etc...)

Options

  • Limit number of returned items
    • Default limit: 10
  • Load full articles
    • Cache articles (articles are stored in a local cache on first request): Doesn't seem useful given how active some lists are.
  • Balance requests (RSS-Bridge uses cached versions to reduce bandwith usage)
    • Timeout (default = 5 minutes, max = 24 hours): 5 minutes

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by inspecting the example GNU Mailman archive at https://mailarchive.ietf.org/arch/browse/calsify/ and compare its pages with the requested RSS-Bridge output. Done means producing a feed with post links, subjects, author, timestamp, content, attachments, thread navigation where available, and the stated item-limit and caching options.

Written by the indexing model from the issue text.

Assessment

Tech stack
php
Domain
backend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.