Re: [Tools-discuss] Missing stuff in author tools Content Guide

Brian E Carpenter <brian.e.carpenter@gmail.com> Sun, 08 May 2022 20:54 UTC

Return-Path: <brian.e.carpenter@gmail.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 C63B3C14F73F; Sun, 8 May 2022 13:54:21 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -3.955
X-Spam-Level:
X-Spam-Status: No, score=-3.955 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, FREEMAIL_FROM=0.001, NICE_REPLY_A=-1.857, RCVD_IN_DNSWL_BLOCKED=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001] autolearn=ham autolearn_force=no
Authentication-Results: ietfa.amsl.com (amavisd-new); dkim=pass (2048-bit key) header.d=gmail.com
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 Hxgx5oa1kDdm; Sun, 8 May 2022 13:54:17 -0700 (PDT)
Received: from mail-pf1-x433.google.com (mail-pf1-x433.google.com [IPv6:2607:f8b0:4864:20::433]) (using TLSv1.3 with cipher TLS_AES_128_GCM_SHA256 (128/128 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 D708CC14F726; Sun, 8 May 2022 13:54:17 -0700 (PDT)
Received: by mail-pf1-x433.google.com with SMTP id c14so10644082pfn.2; Sun, 08 May 2022 13:54:17 -0700 (PDT)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=subject:to:cc:references:from:message-id:date:user-agent :mime-version:in-reply-to:content-language; bh=VQKMgmEQkqaZVZfs27ZUpmA8SofXumCGUmytqi9dyWg=; b=OsDm+N29gFTnDGqHr4MdEd+GaLZB1CGDEzGttJd6pvmzhsYn6Fo0eX1dLv9+He+Lui chhEczsXfja4N4BzymyQX122abXsVrKaF9btRTyPdwnom86meEYzZBrEBPXqn+7/Y0oa kN0Ql/m9PMZUxAiN3N2PfovGXpQX3VQ4tVao/vbULPhIZTXBoQOPyAz9kYwx3MGrXFEB qv7lPaPdu/nkMD6WsbXgiPB3QmmGA8pUhdhVKxQBEaxXLHABsQS1GO7GUx7/gTOkWYFu w7IHJ7jsB7Acn+7vnsnSmy/Be+voAVbvV1bkAzl3Jkb2i4law/G2QzFg4GS3jQQcwTUw VzeQ==
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:subject:to:cc:references:from:message-id:date :user-agent:mime-version:in-reply-to:content-language; bh=VQKMgmEQkqaZVZfs27ZUpmA8SofXumCGUmytqi9dyWg=; b=Q2v2t52qJlusu8y8nAjR/kjbA0+XfPPjqfIFoysD+UCejZLd1u0Uwsawaca73q+U0+ ggyG5pgvJN0bpe962N7PkdhAmb+6jt6Ni0iQUxJoEL5WctUtO+sZ3zU9pze7B0V+mXGe 8Dai8fjAQIOoBV8klU5iSp2ofIrBru1LDua6Bz4JI/IEsFXDCPjQMOeiNKS1vwQpenkd ABBW5vJ52lkstJ9e2n0TRUvchivtoqXau4LANvFJxs9Bj89NIiBGr7JGECMZGojKjdeZ d6UffAUuITKp2FMyRKrR3nd3KKfyepqzw8mwEHxhPjv3pV6rUUHBIMB2Ov9juperUnP7 s3OA==
X-Gm-Message-State: AOAM533DFELASw4Oc9de6J014yIEz31rcqonJh+gKLPBfQ30sZsvFzhO idBWDg1JhrVRRfPZ2Ka1tMS7SgEjRzphwQ==
X-Google-Smtp-Source: ABdhPJzpZJDmk3d8ILoj97OnWwuPk4Cee3lRL9x73YJJlqCp9lk7z0eid/6gzkqJT/hKx2SHY+Dz9A==
X-Received: by 2002:a63:4b42:0:b0:3c6:3c00:2608 with SMTP id k2-20020a634b42000000b003c63c002608mr10723515pgl.231.1652043256823; Sun, 08 May 2022 13:54:16 -0700 (PDT)
Received: from ?IPv6:2406:e003:1005:b501:80b2:5c79:2266:e431? ([2406:e003:1005:b501:80b2:5c79:2266:e431]) by smtp.gmail.com with ESMTPSA id f190-20020a6238c7000000b0050dc762815dsm7039755pfa.55.2022.05.08.13.54.14 (version=TLS1_3 cipher=TLS_AES_128_GCM_SHA256 bits=128/128); Sun, 08 May 2022 13:54:15 -0700 (PDT)
To: Jay Daley <exec-director@ietf.org>
Cc: Tools Team Discussion <tools-discuss@ietf.org>
References: <6a767d3f-6835-d450-bfe9-f1589162a0d2@gmail.com> <342852FE-69E9-4EBD-B203-98FEC0FDE99B@ietf.org> <c028097b-fd74-c44c-533c-b1a4fa237cd1@gmail.com> <CF1CD3A3-80B6-4DDD-8FB3-AB97FEBA9F21@ietf.org>
From: Brian E Carpenter <brian.e.carpenter@gmail.com>
Message-ID: <78c5ab65-0f0d-696e-c419-b1efb8d33d6b@gmail.com>
Date: Mon, 09 May 2022 08:54:11 +1200
User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:78.0) Gecko/20100101 Thunderbird/78.10.0
MIME-Version: 1.0
In-Reply-To: <CF1CD3A3-80B6-4DDD-8FB3-AB97FEBA9F21@ietf.org>
Content-Type: multipart/mixed; boundary="------------ABE44A0EDBD70E7393EB77D0"
Content-Language: en-US
Archived-At: <https://mailarchive.ietf.org/arch/msg/tools-discuss/MB0AavcLU-PfdXpwSETOzE8ZSCg>
Subject: Re: [Tools-discuss] Missing stuff in author tools Content Guide
X-BeenThere: tools-discuss@ietf.org
X-Mailman-Version: 2.1.34
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: Sun, 08 May 2022 20:54:21 -0000

Jay,

Here's a short markdown file. I borrowed some text directly from the RFCs 
invoked.

Regards
    Brian

On 04-May-22 05:08, Jay Daley wrote:
> 
>> On 2 May 2022, at 23:17, Brian E Carpenter <brian.e.carpenter@gmail.com <mailto:brian.e.carpenter@gmail.com>> wrote:
>>
>> Thanks Jay. Might I suggest a separate heading, though? I would never have expected this to be under "Language and style", which is why I didn't find it.
> 
> Yes I agree.  When putting this site together there was some strong pushback to having short pages but in this case I think it is needed.  I will create an "Example Addresses" page with the existing text moved 
over. That’s strictly adhering to how the last I-D guidelines had 
it.
> 
>>
>> While I'm here, could we also mention the (optional) Implementation Status Section (BCP205/RFC7942)? This is underused but very desirable, so maybe the "Required content" section could be renamed "Required and desirable content".
>>
>> Similarly, I see no mention of (optional) Privacy Considerations as suggested by RFC6973.
> 
> In both cases could you please suggest some text?
> 
> BTW the old I-D Guidelines can be more easily found at https://github.com/ietf/id-guidelines <https://github.com/ietf/id-guidelines>
> 
> Jay
> 
>>
>> Regards
>>   Brian
>>
>> On 02-May-22 21:02, Jay Daley wrote:
>>>> On 30 Apr 2022, at 06:10, Brian E Carpenter <brian.e.carpenter@gmail.com <mailto:brian.e.carpenter@gmail.com>> wrote:
>>>>
>>>> Hi,
>>>>
>>>> I needed to remind myself of the range of documentation addresses, so I clicked on the old link for that:
>>>> https://www.ietf.org/standards/ids/checklist/ <https://www.ietf.org/standards/ids/checklist/>
>>>>
>>>> Oh dear, it redirected me to the generic author tools page. So I looked around for the I-D checklist and couldn't find it. I did find the "Content guide" menu but couldn't find what I needed.
>>>>
>>>> I eventually found it at:
>>>> https://web.archive.org/web/20210512111059/https://www.ietf.org/standards/ids/checklist/
>>>>
>>>> There seems to be a chunk of the material at the bottom of "3. Content Issues" that has gone missing, unless I have somehow overlooked it: Bullet 6, with the recommendations for documentation IP addresses (and telephone numbers). It's still important to use these (and I assume idnits still checks).
>>> https://authors.ietf.org/en/language-and-style#example-addresses <https://authors.ietf.org/en/language-and-style#example-addresses>
>>> JaY
>>>>
>>>> (Nit in the original: 2001:DB8::/32 should be 2001:db8::/32 these days.)
>>>> Regards
>>>>   Brian
>>>>
>>>> ___________________________________________________________
>>>> Tools-discuss mailing list - Tools-discuss@ietf.org
>>>> This list is for discussion, not for action requests or bug reports.
>>>> * Report datatracker and mailarchive bugs to: datatracker-project@ietf.org
>>>> * Report tools.ietf.org bugs to: webmaster@tools.ietf.org
>>>> * Report all other bugs or issues to: ietf-action@ietf.org
>>>> List info (including how to Unsubscribe): https://www.ietf.org/mailman/listinfo/tools-discuss
>>>>
>>
> 
> -- 
> Jay Daley
> IETF Executive Director
> exec-director@ietf.org <mailto:exec-director@ietf.org>
>