ietf-tools / www

A customized CMS for the IETF website
BSD 3-Clause "New" or "Revised" License
26 stars 43 forks source link

working group snippets need updating #279

Closed ghwood closed 10 months ago

ghwood commented 1 year ago

The WG snippets need updating in a few ways.

1) the URLs built on the "Acronym field" currently take the form of https://datatracker.ietf.org/wg/FOO when the current base URL should be https://datatracker.ietf.org/group

2) the "list subscribe" field currently only accepts email addresses (even when updating existing WG snippets) when it should be a URL

image
mgax commented 10 months ago

2. the "list subscribe" field currently only accepts email addresses (even when updating existing WG snippets) when it should be a URL

Should the field always be an http(s) URL? There are some email values currently in the database, e.g. bpf@ietf.org, mls@ietf.org. Perhaps they should be converted to their web page equivalent (e.g. https://www.ietf.org/mailman/listinfo/bpf)? And while I'm at it, should I convert http URLs to https?

ghwood commented 10 months ago

Given, recent and upcoming changes, I'm looking at @rjsparks to confirm that the place to point folks to subscribe to an IETF mail list should always be on the web and use HTTPS.

mgax commented 10 months ago

And while I'm at it, should I convert http URLs to https?

To clarify, I'm not suggesting an automated way to generate the URLs, but rather a one-time data migration. Perhaps it's a bit overkill given there are so few WG snippets in the database.

I guess the most important question is whether the "list subscribe" field should still allow email values, and if so, would it be fine to reformat them as actual mailto: URLs, so that the database values are all valid URLs.

ghwood commented 10 months ago

got it. And, looking at this a little closer, the main thing is to allow "list subscribe" to be URLs. There are so few of these (and I'm not recalling exactly how/where they are used—and some may actually be for concluded WGs where the email list is no longer available for subscription—that we'll need to review and update them manually anyway.

rjsparks commented 10 months ago

Yes, we will always advertise the web mechanic for managing subscriptions going forward, whether an email based mechanic to do so exists or not.

rjsparks commented 10 months ago

a data migration for any URLs pointing into ietf.org, iab.org, irtf.org, rfc-editor.org make sense - those will all redirect to https anyhow. If there are any that point to domains out of our control, we don't know whether https will work without a manual check.

mgax commented 10 months ago

There are so few of these (and I'm not recalling exactly how/where they are used

Looking at the References Index, the only page that currently displays a Working Group snippet is the homepage:

It's possible for Standard pages to reference a Mailing list signup snippet, which in turn may reference a Working group snippet. In that case, the list_subscribe link will be displayed under the main content.

rjsparks commented 10 months ago

Not trying to change the work here (yet), but I do have to point out that this is building a redundant set of data with the datatracker and that the data can get stale. I wonder if there's already the general notion of a snippet that takes a field (or two) and uses an API to go get the fill-in data from somewhere else. If so, when does that API fetch take place? (I ask, because for this snippet, providing an acronym like "dispatch" and then pulling values out of https://datatracker.ietf.org/api/v1/group/group/?acronym=dispatch might make more sense in the long run, though Greg might want to add a richer description.

mgax commented 10 months ago

I wonder if there's already the general notion of a snippet that takes a field (or two) and uses an API to go get the fill-in data from somewhere else. If so, when does that API fetch take place?

@rjsparks there's no such built-in mechanism; if data were to be pulled from an external source, we would go for an ad-hoc solution, like creating a management command to sync records, and running it periodically (e.g. daily). The initial sync would happen when the snippet is created.

Two issues come to mind, which are not necessarily specific to syncing from datatracker.ietf.org, which I've missed in the initial audit:

rjsparks commented 10 months ago

The management command based sync is what we have been ripping out (perhaps it was done badly the first time). I don't want to return there without a discussion about architecture that's larger than this current project.

We need to defer discussion of central capture for the moment - our new architecture plans for that are still being worked out.

Is correcting automated CF cache invalidation a reasonable separate task to add to the current project?

mgax commented 10 months ago

Is correcting automated CF cache invalidation a reasonable separate task to add to the current project?

Yes, it looks like it might fit within the timeframe, let's add it tentatively.