[rfc-i] standards for references/URLs in RFCs ? (Was: Re: archiving outlinks in RFCs)

Toerless Eckert <tte@cs.fau.de> Wed, 26 April 2023 06:54 UTC

Return-Path: <eckert@i4.informatik.uni-erlangen.de>
X-Original-To: rfc-interest@ietfa.amsl.com
Delivered-To: rfc-interest@ietfa.amsl.com
Received: from localhost (localhost []) by ietfa.amsl.com (Postfix) with ESMTP id 843FAC1516F2; Tue, 25 Apr 2023 23:54:47 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -1.646
X-Spam-Status: No, score=-1.646 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, HEADER_FROM_DIFFERENT_DOMAINS=0.25, RCVD_IN_ZEN_BLOCKED_OPENDNS=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, URIBL_BLOCKED=0.001, URIBL_DBL_BLOCKED_OPENDNS=0.001, URIBL_ZEN_BLOCKED_OPENDNS=0.001] autolearn=no autolearn_force=no
Received: from mail.ietf.org ([]) by localhost (ietfa.amsl.com []) (amavisd-new, port 10024) with ESMTP id mNVX7t9o78bu; Tue, 25 Apr 2023 23:54:43 -0700 (PDT)
Received: from faui40.informatik.uni-erlangen.de (faui40.informatik.uni-erlangen.de [IPv6:2001:638:a000:4134::ffff:40]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 1DAD5C1516EA; Tue, 25 Apr 2023 23:54:41 -0700 (PDT)
Received: from faui48e.informatik.uni-erlangen.de (faui48e.informatik.uni-erlangen.de [IPv6:2001:638:a000:4134::ffff:51]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (No client certificate requested) by faui40.informatik.uni-erlangen.de (Postfix) with ESMTPS id 4Q5qNr5n5sznkgt; Wed, 26 Apr 2023 08:54:36 +0200 (CEST)
Received: by faui48e.informatik.uni-erlangen.de (Postfix, from userid 10463) id 4Q5qNr5Cq3zkvj1; Wed, 26 Apr 2023 08:54:36 +0200 (CEST)
Date: Wed, 26 Apr 2023 08:54:36 +0200
From: Toerless Eckert <tte@cs.fau.de>
To: Alexis Rossi <rsce@rfc-editor.org>
Cc: rfc-interest@rfc-editor.org
Message-ID: <ZEjKrJK/LGvyHzog@faui48e.informatik.uni-erlangen.de>
References: <E024D9AC-2B92-4720-9713-519592D2362B@rfc-editor.org>
MIME-Version: 1.0
Content-Type: text/plain; charset="utf-8"
Content-Disposition: inline
Content-Transfer-Encoding: 8bit
In-Reply-To: <E024D9AC-2B92-4720-9713-519592D2362B@rfc-editor.org>
Archived-At: <https://mailarchive.ietf.org/arch/msg/rfc-interest/PdGRosNIwQm-6XzbwQ0abnP9_14>
Subject: [rfc-i] standards for references/URLs in RFCs ? (Was: Re: archiving outlinks in RFCs)
X-BeenThere: rfc-interest@rfc-editor.org
X-Mailman-Version: 2.1.39
Precedence: list
List-Id: "A list for discussion of the RFC series and RFC Editor functions." <rfc-interest.rfc-editor.org>
List-Unsubscribe: <https://mailman.rfc-editor.org/mailman/options/rfc-interest>, <mailto:rfc-interest-request@rfc-editor.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/rfc-interest/>
List-Post: <mailto:rfc-interest@rfc-editor.org>
List-Help: <mailto:rfc-interest-request@rfc-editor.org?subject=help>
List-Subscribe: <https://mailman.rfc-editor.org/mailman/listinfo/rfc-interest>, <mailto:rfc-interest-request@rfc-editor.org?subject=subscribe>
X-List-Received-Date: Wed, 26 Apr 2023 06:54:47 -0000


Thanks a lot for the initiative, but before having more opinion about it, i would
like to reconfirm our current policies for new draft->RFC, and what type of
references/URLs are permitted/required by our process (IETF and RFC-editor).

For example, in one of my ongoing WG drafts, WG members made the comment that
a reference to a github location would not be looked upon favorably by RFC editor.
Aka: inappropriate reference because it is not stable.

In that particular case, the github file was part of a presentation given at a
WG meeting in the past, so our plan for this reference is to use the IETF proceeding URL
for the presentation instead.

[ Which should be considered to be an eternally stable URL, one would hope, unless we
  do get IETF LLC? web admins that like in almost all commercial web pages of our industry
  seem to be run by admins that like to drive users mad by randomnly deleting important
  reference/history information or just changing URLs for spite or some new wb page tooling
  that "did not allow us to keep existing URLs" (typical excuse i hear). /rant ]

Aka: I am totally unclear what type of URLs are or are not seen as
appropriate today by IETF process/RFC-Editor, and if someone could point me to any
reference we have (RFC ? www.ietf.org/.... ?), that would be lovely.

As another example, when defining terms, i sometimes thought it would be appropriate
to point to wikipedia. But given how the understanding of terms is changing over time,
wikipedia definitions might be the worst references to use. Just think of all the
technical terms we where fond of using (e.g.: blacklist) and that are now shunned/deprecated
by us (not even sure what the right word for the process is ;-) - as one example category
for this problem. If at all, it seems to me that references to wikipedia could
really only go to an archived version of a wikipedia page that was used by the authors
when writing the draft/RFC.


On Tue, Apr 25, 2023 at 11:50:24AM -0700, Alexis Rossi wrote:
> Hi all,
> I wanted to let the community know about something I’ve been working on. As you might know, one of my previous jobs was running the Wayback Machine, so when I started working with with this collection of RFCs one of my first thoughts was, “I wonder how many broken links are in these RFCs from the past few decades?” 
> In general, the average lifespan of a URL before the content changes or disappears is on the order of 100 days. Fortunately for us, the links used in RFC references seem to be much more stable than that. For instance, so far I’ve only found one broken link in an RFC from the past 6 months [1].
> Even though we favor these more stable URLs, some of them will eventually change or go 404 and having archival documents with link rot is something we can take steps to avoid in the future.
> The first thing I wanted to do was just make sure we were archiving these outlinks somewhere. This won’t fix a broken link in the RFC, but at least the resource can be saved elsewhere for someone curious enough to go look (and potentially we could fix links in some version of the RFC in future).
> The main services that are well qualified for this purpose are Archive-It.org <http://archive-it.org/> (run by the Internet Archive) and Perma.cc <http://perma.cc/> (run by Harvard Law School Library). I chose Archive-It, and when I approached them they offered us an account [2] with enough free data storage for our needs. Yay for non-profits supporting each other! 
> So far I have used Archive-It to:
> Archive rfc-editor.org <http://rfc-editor.org/>, iab.org <http://iab.org/>, irtf.org <http://irtf.org/>, and ietf.org <http://ietf.org/> (minus datatracker and the mail archive)
> There are lots of references to these sites in RFCs, but I also wanted to preserve the contents for their own sake. I plan to revisit these sites once per year.
> I am avoiding datatracker (except for outlinks from RFCs) because of concern about the extra traffic causing problems for the team that maintains the site.
> I have not concentrated on archiving the mail archive yet, though I know some of it has been saved incidentally. 
> Archive outlinks from RFCs
> About once per quarter I’ll grab the outlinks from newly published RFCs and get them crawled. 
> I am also going backwards through the entire series - I’ve started with the most recent RFCs (links are more likely to still be live) and am working my way back in time. 
> There may be more room for improvements here, for example including archived links in RFCs from the start w here appropriate, or potentially defining a way for links to be self-healing in published RFCs. 
> Please let me know if you have ideas or feedback on this.
> Thanks,
> Alexis
> [1] RFC9311 published in September 2022, in Section 11 (Informative References) this link is 404: https://www.ietf.org/how/meetings/98/bits-n-bites/ <https://www.ietf.org/how/meetings/98/bits-n-bites/>[2] https://archive-it.org/organizations/2540 <https://archive-it.org/organizations/2540>

> _______________________________________________
> rfc-interest mailing list
> rfc-interest@rfc-editor.org
> https://mailman.rfc-editor.org/mailman/listinfo/rfc-interest