Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Announcement of updates / RSS feed #358

Closed
evanmiltenburg opened this issue May 24, 2019 · 24 comments · Fixed by #2744
Closed

Announcement of updates / RSS feed #358

evanmiltenburg opened this issue May 24, 2019 · 24 comments · Fixed by #2744
Labels
enhancement good first project Good projects for new contributors help wanted Interesting but beyond current volunteer bandwidth

Comments

@evanmiltenburg
Copy link

Updates to the Anthology used to be announced through this Google group, but it seems that's no longer the case.

Would it be possible to provide some kind of updates, either through mail or RSS? I'd imagine that RSS is relatively easy, since it could be generated along with any other updates of the anthology.
@akoehn
Copy link
Member

akoehn commented May 24, 2019

RSS would be nice, but the repository would need some kind of NEWS file (or directory) to generate the feed from. There is currently no machine-readable list of relevant changes; the git commits cover all kinds of stuff and only some of them are relevant to a wider audience.

@mjpost
Copy link
Member

mjpost commented May 24, 2019

Min turned the keys of that list over to me but I haven't been using it. I didn't expect that people actually followed it!

I would love to have this done automatically, and an RSS feed is a good idea. I have discussed the need to note publication dates (#319), so this could fit in with that. It could work by having a script that parsed all the XML, pulled these dates out, sorted them, and then generated a chronological RSS feed from them, as part of the hugo build.

@evanmiltenburg
Copy link
Author

Ah yes, I've been using it to keep track of all proceedings, usually posting them to Twitter as well. So I thought the proceedings for many conferences were just delayed, until I saw that they were actually uploaded. (Relevant XKCD: https://xkcd.com/1172/)

Related: a Twitter bot for the proceedings would also be cool, but if the RSS is there then that should be easy for interested parties to build.

@mjpost
Copy link
Member

mjpost commented May 28, 2019

I think I have an idea of how to do this, and plan to add an RSS feed, once I manage to get #317 done (currently on hold in PR #324).

mjpost added a commit that referenced this issue Jun 21, 2019
@mjpost
Nested volumes and explicit <url> tags (#324)
0b4ea37 
A summary of changes:

- Introduces a nested format (closes #317)
- URLs are stored using a relative format for internal links (closes #156), which facilitates mirroring (#295) 
- URLs are only displayed if they are found in the XML. I manually crawled to validate and create entries for PDFs for all frontmatter entries (closes #181 closes #180), including journal frontmatter (#264) and volume PDFs (closes #31) 
- Added missing entries and removed ones whose PDFs were missing, including LREC 2014 (closes #31 )
- It punts on C69 reformatting (closes #147)

Relevant, but not completed:
- Creating PDF volumes by pasting together individual papers (#226)
- This makes it much easier to add non-paper entries such as talks (#298), to add a volume-level "publication date (#319), and to create an RSS feed of updates (#358),
@mjpost
Copy link
Member

mjpost commented Jun 24, 2019

@mbollmann (or anyone) do you have any thoughts on how to do an RSS feed with Hugo? I know there is built-in tools for this, but they assume a blogging format that I don't think will apply. I have a feed.xml file and was planning to use it as a template, filling it with all volumes and papers which are tagged with an ingestion-date attribute. I welcome thoughts on this.

@akoehn akoehn mentioned this issue Jul 18, 2019
Open
@mjpost mjpost mentioned this issue Aug 16, 2019
Merged
@mjpost mjpost mentioned this issue Sep 30, 2019
Closed
@mjpost mjpost pinned this issue Oct 1, 2019
@mjpost mjpost changed the title Announcement of updates Announcement of updates / RSS feed Oct 1, 2019
@mjpost mjpost added enhancement good first project Good projects for new contributors help wanted Interesting but beyond current volunteer bandwidth labels Oct 1, 2019
@mjpost
Copy link
Member

mjpost commented Oct 1, 2019

FYI, for anyone maybe interested in this Volumes (<volume> tags in the XML) now have an ingest-date attribute. It would be easy to loop over these and generate an RSS feed from volume that have this tag, updating it each time the site is built via a root-level feed.xml Hugo template.

@mjpost mjpost unpinned this issue Dec 14, 2019
@mjpost mjpost mentioned this issue Dec 31, 2019
Open
@mjpost mjpost pinned this issue Apr 27, 2020
@mjpost
Copy link
Member

mjpost commented Apr 27, 2020

Just to re-up this: This should be a simple matter of writing a Python script that searches for all date-tagged volumes in the Anthology, and fills an XML template.

@mbollmann
Copy link
Member

It might be sensible to integrate this with Hugo though, as this seems very much related to #722.

@akoehn
Copy link
Member

akoehn commented Apr 27, 2020

This misses all corrections we make. The corrections are probably only if interest to dblp and the like but maybe they want to be updated as well.

@mjpost
Copy link
Member

mjpost commented Apr 27, 2020

Revisions now also require a date, so those could be added to the script.

It'd be great to have this be Hugo native, but I have much less of an idea how to go about that.

@mbollmann
Copy link
Member

It'd be great to have this be Hugo native, but I have much less of an idea how to go about that.

Basically by creating a Hugo page for every update (e.g., under /updates/) and writing a Hugo RSS template that produces the feed in the desired format.

The advantage would be that users could easily browse the updates on the website, we could automatically show the latest N updates on the front page, and it could be combined with actual blog posts as the underlying mechanism will be exactly the same.

@mjpost
Copy link
Member

mjpost commented Apr 27, 2020

This is perfect, a really nice idea.

@mjpost
Copy link
Member

mjpost commented May 1, 2020 •
edited
Loading

Related to this, it would be really nice to offer RSS feeds for authors. Generating an Atom XML file (e.g., like arxiv does) probably wouldn't be too difficult.

@akoehn
Copy link
Member

akoehn commented May 8, 2020

@mjpost with corrections I meant something like fixing a name spelling in the XML, not a correction to a paper. If this is intended for ingestion by dblp or the like, they probably want to update the metadata they scraped from us.

@mjpost mjpost mentioned this issue May 13, 2020
Open
@mjpost mjpost mentioned this issue Jun 22, 2020
Merged
@mjpost mjpost unpinned this issue Jul 10, 2020
najtin pushed a commit to ir-anthology/ir-anthology that referenced this issue Jun 9, 2021
@mjpost
Nested volumes and explicit <url> tags (acl-org#324)
956cf69 
A summary of changes:

- Introduces a nested format (closes acl-org#317)
- URLs are stored using a relative format for internal links (closes acl-org#156), which facilitates mirroring (acl-org#295) 
- URLs are only displayed if they are found in the XML. I manually crawled to validate and create entries for PDFs for all frontmatter entries (closes acl-org#181 closes acl-org#180), including journal frontmatter (acl-org#264) and volume PDFs (closes #31) 
- Added missing entries and removed ones whose PDFs were missing, including LREC 2014 (closes #31 )
- It punts on C69 reformatting (closes acl-org#147)

Relevant, but not completed:
- Creating PDF volumes by pasting together individual papers (acl-org#226)
- This makes it much easier to add non-paper entries such as talks (acl-org#298), to add a volume-level "publication date (acl-org#319), and to create an RSS feed of updates (acl-org#358),
@CSchoel
Copy link
Contributor

CSchoel commented Aug 3, 2023

Hey there. 👋 I just wanted to ask if there is still interest in this feature. If this is the case, I would like to help out and implement it. I don't want to give any promises yet, but I might be able to work on it next week.

@mjpost
Copy link
Member

mjpost commented Aug 3, 2023

Yes, this would be great! It would help us consolidate some of our documentation, and would make it easier to announce things like new ingestions.

This is a very old issue, so much has changed underneath. I think the basic need at this point is:

  • A /posts/ directory where we can place new blog posts and announcements (we're open to naming suggestions)
  • A root-level RSS feed

@CSchoel
Copy link
Contributor

CSchoel commented Aug 4, 2023

Nice! Thanks for the swift reply and the update on what needs to happen. Are there any other guidelines or starting points I should be aware of other than the README_detailed.md and the Hugo documentation?

@mbollmann
Copy link
Member

It might be worth keeping in mind that some details in the docs may be outdated, so if anything is unclear, just ask here. :)

This was referenced Aug 7, 2023
Closed
Closed
Closed
@CSchoel
Copy link
Contributor

CSchoel commented Aug 7, 2023

Thanks again. 😃 I started with writing a few issues for myself today, but didn't get to coding anything yet. There are some open questions in CSchoel#2 and CSchoel#3, though.

This was referenced Aug 19, 2023
Merged
Merged
@mbollmann
Copy link
Member

This feature is coming together now in #2744 (thanks @CSchoel!), with a preview being generated through #2859 here:

It implements both the RSS feed and #722.

@mjpost and others: I think this is ready for your comments. It might need some more tweaking (e.g. layout of news section, exact content of RSS feed, ... also, the RSS feed is currently invalid XML due to an unescaped &, hope to fix that soon). But it looks fully usable at this stage, and I'd love some other pairs of eyes to look at this than my own. ;)

@CSchoel
Copy link
Contributor

CSchoel commented Nov 3, 2023

The issue with the unescaped & should be fixed once the preview is updated to the current branch version. See #2744 (comment).

@CSchoel
Copy link
Contributor

CSchoel commented May 5, 2024

Hey @mbollmann @mjpost. 👋 It's been quiet for a while here. If there is anything that you need from me, please let me know. I don't have a lot of time on my hands, but I still want to help to get this done. 💪 😄

@mjpost
Copy link
Member

mjpost commented May 5, 2024

Hi @CSchoel, thanks for following up. This is my fault. I'll review this as soon as possible and get back to you. In the meantime if you want to merge in the latest master that'd be great.

@mbollmann
Copy link
Member

@mjpost I merged in master in our duplicate of @CSchoel’s implementation #2859 where it also generates a preview.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement good first project Good projects for new contributors help wanted Interesting but beyond current volunteer bandwidth
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add section for announcements and RSS feeds CSchoel/acl-anthology
5 participants
@akoehn @mjpost @evanmiltenburg @CSchoel @mbollmann