Re: [Tools-discuss] Listing updating RFCs in RFCs

Sandy Ginoza <sginoza@amsl.com> Tue, 09 April 2024 17:58 UTC

Return-Path: <sginoza@amsl.com>
X-Original-To: tools-discuss@ietfa.amsl.com
Delivered-To: tools-discuss@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id 268F5C14F721 for <tools-discuss@ietfa.amsl.com>; Tue, 9 Apr 2024 10:58:10 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -4.198
X-Spam-Level:
X-Spam-Status: No, score=-4.198 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, RCVD_IN_DNSWL_MED=-2.3, RCVD_IN_ZEN_BLOCKED_OPENDNS=0.001, SPF_PASS=-0.001, URIBL_DBL_BLOCKED_OPENDNS=0.001, URIBL_ZEN_BLOCKED_OPENDNS=0.001] autolearn=ham autolearn_force=no
Received: from mail.ietf.org ([50.223.129.194]) by localhost (ietfa.amsl.com [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id ztNXzWkwyOyA for <tools-discuss@ietfa.amsl.com>; Tue, 9 Apr 2024 10:58:06 -0700 (PDT)
Received: from c8a.amsl.com (c8a.amsl.com [4.31.198.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 04F19C14EB19 for <tools-discuss@ietf.org>; Tue, 9 Apr 2024 10:58:05 -0700 (PDT)
Received: from localhost (localhost [127.0.0.1]) by c8a.amsl.com (Postfix) with ESMTP id C82CB424B427; Tue, 9 Apr 2024 10:58:05 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
Received: from c8a.amsl.com ([127.0.0.1]) by localhost (c8a.amsl.com [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id AFI7kv_LgSDQ; Tue, 9 Apr 2024 10:58:05 -0700 (PDT)
Received: from smtpclient.apple (172-113-155-155.res.spectrum.com [172.113.155.155]) by c8a.amsl.com (Postfix) with ESMTPSA id 9B28B424B426; Tue, 9 Apr 2024 10:58:05 -0700 (PDT)
Content-Type: text/plain; charset="utf-8"
Mime-Version: 1.0 (Mac OS X Mail 14.0 \(3654.120.0.1.13\))
From: Sandy Ginoza <sginoza@amsl.com>
In-Reply-To: <2FC07D4D-1A55-4D74-9F60-9AC0A99D3983@jisc.ac.uk>
Date: Tue, 09 Apr 2024 10:56:59 -0700
Cc: Brian E Carpenter <brian.e.carpenter@gmail.com>, "tools-discuss@ietf.org" <tools-discuss@ietf.org>
Content-Transfer-Encoding: quoted-printable
Message-Id: <119EC019-7695-45E0-9309-C406D716C501@amsl.com>
References: <F57FE4CD-B25F-41E0-A018-A7329BEA26AD@jisc.ac.uk> <989C9FA6-6134-4FA8-9401-04C0E83E6A88@gmail.com> <6EDDBE23-7007-4A60-98FC-B3A993E87DA6@jisc.ac.uk> <65c0e745-f54e-4701-af8f-d6609a9a633d@gmail.com> <2FC07D4D-1A55-4D74-9F60-9AC0A99D3983@jisc.ac.uk>
To: Tim Chown <Tim.Chown=40jisc.ac.uk@dmarc.ietf.org>
X-Mailer: Apple Mail (2.3654.120.0.1.13)
Archived-At: <https://mailarchive.ietf.org/arch/msg/tools-discuss/QuleO--TlrRIoPYL4xwidaQ4INg>
Subject: Re: [Tools-discuss] Listing updating RFCs in RFCs
X-BeenThere: tools-discuss@ietf.org
X-Mailman-Version: 2.1.39
Precedence: list
List-Id: IETF Tools Discussion <tools-discuss.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/tools-discuss>, <mailto:tools-discuss-request@ietf.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/tools-discuss/>
List-Post: <mailto:tools-discuss@ietf.org>
List-Help: <mailto:tools-discuss-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/tools-discuss>, <mailto:tools-discuss-request@ietf.org?subject=subscribe>
X-List-Received-Date: Tue, 09 Apr 2024 17:58:10 -0000

Hi Tim, 

Thank you for bringing this to our attention.  We need to investigate this further.  It may be an issue specific to RFC 4861, as some other RFCs with long lists of "Updated by" relationships seem to display correctly (for example, see https://www.rfc-editor.org/rfc/rfc3261.html).  The relevant information for RFC 4861 is correct in our database, so it is not clear why the list is truncated in the header.  

Thanks,
Sandy 

> On Apr 9, 2024, at 12:48 AM, Tim Chown <Tim.Chown=40jisc.ac.uk@dmarc.ietf.org> wrote:
> 
> Hi,
> 
>> On 8 Apr 2024, at 22:11, Brian E Carpenter <brian.e.carpenter@gmail.com> wrote:
>> 
>> I think this discussion belongs as much on rfc-interest as here.
> 
> Feel free to send it there :)
> 
>> In line:
>> 
>> On 09-Apr-24 02:55, Tim Chown wrote:
>>> Hi Bob,
>>>> On 8 Apr 2024, at 15:48, Bob Hinden <bob.hinden@gmail.com> wrote:
>>>> 
>>>> Tim,
>>>> 
>>>>> On Apr 8, 2024, at 7:07 AM, Tim Chown <Tim.Chown=40jisc.ac.uk@dmarc.ietf.org> wrote:
>>>>> 
>>>>> Hi,
>>>>> 
>>>>> I was caught out this week looking at RFC 4861 as part of reviewing the draft on a new P bit for PIOs.
>>>>> 
>>>>> I missed the “updated by RFC 8425” on RFC 4861 as I was looking at the HTML rendered version of RFC 4861 at
>>>>> https://www.rfc-editor.org/rfc/rfc4861.html
>> 
>> That is the RFC Editor's version of an htmlized old-style RFC, and apparently it has a bug. That needs to be reported to rfc-editor@rfc-editor.org if you haven't already done so.
> 
> I haven’t, I perhaps rather lazily assumed raising it here would achieve that, but there is the bigger picture of the different formats and what metadata is associated with them and how or if that metadata appears in the document body or not.
> 
>> (I don't know why the RFC Editor and the datatracker don't use the same version of the htmlizer, but I imagine there is a good historical reason.)
> 
> I didn’t realise there was a difference.  I assumed the RFC Editor would use the datatracker as the authoritative source.
> 
>>>>> rather than the datatracker version at
>>>>> https://datatracker.ietf.org/doc/rfc4861/
>>>>> where you can see RFC 8425 (and RFC 9131) listed as updating RFCs which are missing on the HTML rendered version.  There was a clue I missed in that the 7th of 9 RFCs in the Updated by list had a comma after it, but no RFC.
>>>>> 
>>>>> The text and PDF versions don’t show any of the updating RFCs for RFC 4861.
>> 
>> No. The plain text version is immutable by definition, and as far as I know the PDFs for all RFCs before RFC8650 are simply images of the plain text version and also immutable.
> 
> Why does it have to be immutable?  The html and htmlized versions change over time.  You could track the version history if desired.
> 
>>>> The htmlized version:
>>>> 
>>>> https://datatracker.ietf.org/doc/html/rfc4861 <https://datatracker.ietf.org/doc/html/rfc4861>
>>>> 
>>>> Does show the list of updated RFCs in the sidebar.
>>> Thanks, so should we consider the HMTL version as obsolete or no longer supported?
>>> I don’t mind as such, but personally I won’t be looking at the HTML version again having been bitten here. Unfortunately it’s the version google search returns first, so many people will routinely find it.
>> 
>> As I said, I don't know why the two htmlized versions are different.
>> 
>>> Maybe the HTML version should have a clearer indication that the link to “Tracker” at the top is the authoritative source from which other versions can be found?  Quite a few people less familiar with IETF process may have no idea what “Tracker” means.
>> 
>> The *definitive* source for RFCs isn't the datatracker, it's rfc-editor.org. So they need to fix their bug. However, the correct place to start is https://www.rfc-editor.org/info/rfc4861.
> 
> Thanks, as above I didn’t know that the RFC Editor version was the real source.  
> 
>> Unfortunately we can't control what the search engines find first.
>> 
>> (The best source of the metadata is https://www.rfc-editor.org/rfc/rfc-index.xml if you have the stomach for it. Or in human form, https://www.rfc-editor.org/rfc/rfc-index.txt)
> 
> I think what I’d hope for is an authoritative (single) source that gives the content and metadata about a draft, and then renditions of that into formats where the rendered versions are consistent.  At the moment they aren’t.  We should probably be considering what people new to th IETf and standards documents make of it, as we (or rather you and John!) know the specific details and history that may not be obvious to such people.
> 
> Worst case, the Updated by bug needs a fix.
> 
> Tim
> 
>> 
>>   Brian
>> 
>>> Tim
>>>> Bob
>>>> 
>>>>> 
>>>>> I’m wondering whether the updating RFCs should just be metadata to the RFCs, or be included fully in all RFCs in all versions.  It’s a little dangerous/confusing when you only see a partial list.  Or maybe I shouldn’t be looking at the HTML but rather the HTMLised version?
>>>>> 
>>>>> Tim
>>>>> ___________________________________________________________
>>>>> Tools-discuss mailing list - Tools-discuss@ietf.org - https://www.ietf.org/mailman/listinfo/tools-discuss
>>>> 
>>>> ___________________________________________________________
>>>> Tools-discuss mailing list - Tools-discuss@ietf.org - https://www.ietf.org/mailman/listinfo/tools-discuss
>>> ___________________________________________________________
>>> Tools-discuss mailing list - Tools-discuss@ietf.org - https://www.ietf.org/mailman/listinfo/tools-discuss
> 
> ___________________________________________________________
> Tools-discuss mailing list - Tools-discuss@ietf.org - https://www.ietf.org/mailman/listinfo/tools-discuss