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

Jay Daley <exec-director@ietf.org> Tue, 03 May 2022 17:08 UTC

Return-Path: <exec-director@ietf.org>
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 08182C1595FE for <tools-discuss@ietfa.amsl.com>; Tue, 3 May 2022 10:08:44 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -1.102
X-Spam-Level:
X-Spam-Status: No, score=-1.102 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, HTML_MESSAGE=0.001, RCVD_IN_ZEN_BLOCKED_OPENDNS=0.001, RDNS_NONE=0.793, 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 ([50.223.129.194]) by localhost (ietfa.amsl.com [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id k73DivfsVjae for <tools-discuss@ietfa.amsl.com>; Tue, 3 May 2022 10:08:40 -0700 (PDT)
Received: from ietfx.amsl.com (unknown [50.223.129.196]) (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 872AFC14792E for <tools-discuss@ietf.org>; Tue, 3 May 2022 10:08:40 -0700 (PDT)
Received: from localhost (localhost [127.0.0.1]) by ietfx.amsl.com (Postfix) with ESMTP id 3E7C5404C4FD; Tue, 3 May 2022 10:08:40 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
Received: from ietfx.amsl.com ([50.223.129.196]) by localhost (ietfx.amsl.com [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id bUZ7VX92K1_k; Tue, 3 May 2022 10:08:40 -0700 (PDT)
Received: from smtpclient.apple (host-92-27-125-209.static.as13285.net [92.27.125.209]) by ietfx.amsl.com (Postfix) with ESMTPSA id 9003C404C4F1; Tue, 3 May 2022 10:08:39 -0700 (PDT)
From: Jay Daley <exec-director@ietf.org>
Message-Id: <CF1CD3A3-80B6-4DDD-8FB3-AB97FEBA9F21@ietf.org>
Content-Type: multipart/alternative; boundary="Apple-Mail=_9F008D8B-7102-489C-90F9-69B112905813"
Mime-Version: 1.0 (Mac OS X Mail 16.0 \(3696.80.82.1.1\))
Date: Tue, 03 May 2022 18:08:37 +0100
In-Reply-To: <c028097b-fd74-c44c-533c-b1a4fa237cd1@gmail.com>
Cc: Tools Team Discussion <tools-discuss@ietf.org>
To: Brian E Carpenter <brian.e.carpenter@gmail.com>
References: <6a767d3f-6835-d450-bfe9-f1589162a0d2@gmail.com> <342852FE-69E9-4EBD-B203-98FEC0FDE99B@ietf.org> <c028097b-fd74-c44c-533c-b1a4fa237cd1@gmail.com>
X-Mailer: Apple Mail (2.3696.80.82.1.1)
Archived-At: <https://mailarchive.ietf.org/arch/msg/tools-discuss/3uSFd62fNudzuAyhGABkKZNbECE>
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: Tue, 03 May 2022 17:08:44 -0000

> On 2 May 2022, at 23:17, Brian E Carpenter <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> 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/
>>> 
>>> 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
>> 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