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

Jay Daley <exec-director@ietf.org> Sat, 21 May 2022 07:45 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 18E64C14F723 for <tools-discuss@ietfa.amsl.com>; Sat, 21 May 2022 00:45:14 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -1.899
X-Spam-Level:
X-Spam-Status: No, score=-1.899 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, URIBL_BLOCKED=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 muM-bfmC6QDU for <tools-discuss@ietfa.amsl.com>; Sat, 21 May 2022 00:45:10 -0700 (PDT)
Received: from ietfx.amsl.com (ietfx.amsl.com [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 46084C14F717 for <tools-discuss@ietf.org>; Sat, 21 May 2022 00:45:10 -0700 (PDT)
Received: from localhost (localhost [127.0.0.1]) by ietfx.amsl.com (Postfix) with ESMTP id 38D3D436D76C; Sat, 21 May 2022 00:45:10 -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 6_F3S9zJq_3c; Sat, 21 May 2022 00:45:10 -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 03C21404C4CA; Sat, 21 May 2022 00:45:10 -0700 (PDT)
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: quoted-printable
From: Jay Daley <exec-director@ietf.org>
Mime-Version: 1.0 (1.0)
Date: Sat, 21 May 2022 08:45:07 +0100
Message-Id: <85819A66-2378-43BF-8EB8-41296AC564CA@ietf.org>
References: <5c03c58f-27b2-9ae4-378b-e59228223b11@gmail.com>
Cc: Tools Team Discussion <tools-discuss@ietf.org>
In-Reply-To: <5c03c58f-27b2-9ae4-378b-e59228223b11@gmail.com>
To: Brian E Carpenter <brian.e.carpenter@gmail.com>
X-Mailer: iPad Mail (19E258)
Archived-At: <https://mailarchive.ietf.org/arch/msg/tools-discuss/03Eq-orjsrflyQSF9xfnfyXtPDM>
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: Sat, 21 May 2022 07:45:14 -0000


> On 21 May 2022, at 03:14, Brian E Carpenter <brian.e.carpenter@gmail.com> wrote:
> 
> Looks good to me. I assume the RFC and BCP references will appear as links?

Yes, we have customised the page renderer in the wiki platform to do that. 

Jay

-- 
Jay Daley
IETF Executive Director 
exec-director@ietf.org
> 
> Thanks
>   Brian
> 
>> On 21-May-22 00:03, Jay Daley wrote:
>> Hi Brian
>> There’s now a Pull Request for this new content https://github.com/ietf/authors.ietf.org/pull/26 <https://github.com/ietf/authors.ietf.org/pull/26>  Please let me know if this meets your needs and anyone else please feel free to comment.
>> Jay
>>>> On 8 May 2022, at 21:54, Brian E Carpenter <brian.e.carpenter@gmail.com <mailto:brian.e.carpenter@gmail.com>> wrote:
>>> 
>>> 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> <mailto: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> <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> <mailto: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/> <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/ <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> <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 <mailto: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 <mailto:datatracker-project@ietf.org>
>>>>>>> * Report tools.ietf.org <http://tools.ietf.org> bugs to: webmaster@tools.ietf.org <mailto:webmaster@tools.ietf.org>
>>>>>>> * Report all other bugs or issues to: ietf-action@ietf.org <mailto:ietf-action@ietf.org>
>>>>>>> List info (including how to Unsubscribe): https://www.ietf.org/mailman/listinfo/tools-discuss <https://www.ietf.org/mailman/listinfo/tools-discuss>
>>>>>>> 
>>>>> 
>>>> -- 
>>>> Jay Daley
>>>> IETF Executive Director
>>>> exec-director@ietf.org <mailto:exec-director@ietf.org> <mailto:exec-director@ietf.org <mailto:exec-director@ietf.org>>
>>> <desirable.md>
>> -- 
>> Jay Daley
>> IETF Executive Director
>> exec-director@ietf.org <mailto:exec-director@ietf.org>
>