Re: Please look at your groups' charters rendered through markdown

Robert Sparks <rjsparks@nostrum.com> Mon, 11 October 2021 16:25 UTC

Return-Path: <rjsparks@nostrum.com>
X-Original-To: wgchairs@ietfa.amsl.com
Delivered-To: wgchairs@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id B823C3A0C25 for <wgchairs@ietfa.amsl.com>; Mon, 11 Oct 2021 09:25:59 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -2.08
X-Spam-Level:
X-Spam-Status: No, score=-2.08 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, NICE_REPLY_A=-0.001, T_SPF_HELO_TEMPERROR=0.01, T_SPF_PERMERROR=0.01, URIBL_BLOCKED=0.001] autolearn=ham autolearn_force=no
Authentication-Results: ietfa.amsl.com (amavisd-new); dkim=pass (1024-bit key) header.d=nostrum.com
Received: from mail.ietf.org ([4.31.198.44]) by localhost (ietfa.amsl.com [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id YftyhS49D3Rg for <wgchairs@ietfa.amsl.com>; Mon, 11 Oct 2021 09:25:55 -0700 (PDT)
Received: from nostrum.com (raven-v6.nostrum.com [IPv6:2001:470:d:1130::1]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 027413A0C24 for <wgchairs@ietf.org>; Mon, 11 Oct 2021 09:25:54 -0700 (PDT)
Received: from [192.168.1.114] ([47.186.34.206]) (authenticated bits=0) by nostrum.com (8.17.1/8.16.1) with ESMTPSA id 19BGPoN2016990 (version=TLSv1.3 cipher=TLS_AES_256_GCM_SHA384 bits=256 verify=NO); Mon, 11 Oct 2021 11:25:51 -0500 (CDT) (envelope-from rjsparks@nostrum.com)
DKIM-Signature: v=1; a=rsa-sha256; c=simple/simple; d=nostrum.com; s=default; t=1633969551; bh=w1puQsPSdZufSWwEyNjNFjDA15XJwG+h0GxRA8i26vU=; h=Date:To:References:From:Subject:In-Reply-To; b=KkhfNwx7uKG9XVCAUTSMQCAx86cs3xwbWU3tEwlW/HBlXEJteSY38+RN1VcBqWDgJ 4TPdu/8fTMSyovCn2zsmNM2ITZRqfk6SQAYuMknXJCk0eHuDnWXyZRaLJxIEp0CVB8 Nx9Kw35TfPoCleTSSfM15TVc4BJEXzbiuiYApSCs=
X-Authentication-Warning: raven.nostrum.com: Host [47.186.34.206] claimed to be [192.168.1.114]
Message-ID: <92a75b10-a744-1ec9-366e-f0123e564a2c@nostrum.com>
Date: Mon, 11 Oct 2021 11:25:45 -0500
MIME-Version: 1.0
User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:91.0) Gecko/20100101 Thunderbird/91.2.0
Content-Language: en-US
To: Paul Kyzivat <pkyzivat@alum.mit.edu>, wgchairs@ietf.org
References: <91a7eae6-6752-9c25-648a-69c4b75d600b@nostrum.com> <a6c17ed7-ad56-f2d1-60b7-0b1244b9ad0a@alvestrand.no> <7769D773-FA6B-4097-9D67-2A764377A4DA@kuehlewind.net> <2aaffdea-f71d-ef3b-5b3d-996fc4c146b5@nostrum.com> <F841B6CA-0F8A-4B9D-BBE0-45737B344B1B@kuehlewind.net> <f3978c72-f0cd-cad9-3e82-1a68f1e53c84@alum.mit.edu>
From: Robert Sparks <rjsparks@nostrum.com>
Subject: Re: Please look at your groups' charters rendered through markdown
In-Reply-To: <f3978c72-f0cd-cad9-3e82-1a68f1e53c84@alum.mit.edu>
Content-Type: text/plain; charset="UTF-8"; format="flowed"
Content-Transfer-Encoding: 8bit
Archived-At: <https://mailarchive.ietf.org/arch/msg/wgchairs/HAeeI-BPZsgiba0_izN-BYutpYo>
X-BeenThere: wgchairs@ietf.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: Working Group Chairs <wgchairs.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/wgchairs>, <mailto:wgchairs-request@ietf.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/wgchairs/>
List-Post: <mailto:wgchairs@ietf.org>
List-Help: <mailto:wgchairs-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/wgchairs>, <mailto:wgchairs-request@ietf.org?subject=subscribe>
X-List-Received-Date: Mon, 11 Oct 2021 16:26:00 -0000

On 10/11/21 10:42 AM, Paul Kyzivat wrote:
> I don't understand what the goal is here.
See the very start of the thread (at the bottom of this message) - I 
think the goal was explained there, but will clarify more here.
>
> I *guess* the idea is to switch to having the authoritative form of 
> charters be written in markup notation, so that they can then be 
> rendered using the derived html.
>
> Currently they charters are (always / mostly ?) in text form.
They are all in text form, but many have been using markdown-style 
markup already
>
> Is the intent to declare the existing text forms to be markup? And 
> they to have chairs fixup any problems that arise when that text 
> doesn't render well when treated as markup?
The intent is to move to having the charters always be rendered in 
markdown. To be clear, that means that the intent is to always treat 
charter document contents as markdown source. This test page is to help 
us understand what would be needed to get there. From what we've seen so 
far, if we are going to proceed, there's a strong indication of a need a 
way to make cosmetic changes to charters without going through a 
recharter process - I'll be talking to the IESG about that over the next 
few days. There may or may not be a small set of tweaks we can apply 
automatically, once an acceptable process is in place, fixing linebreaks 
and lists for instance.
>
> Or is the intent to allow the charters to be posted with an extension 
> indicating it is markup, and have some sort of conversion process?
>
> Or ...???
>
>     Thanks,
>     Paul
>
> On 10/11/21 10:03 AM, Mirja Kuehlewind wrote:
>> Ah, okay, didn’t realise that. I guess you can just fix that (without 
>> rechartering ;-) )?
>>
>> Mirja
>>
>>
>>
>>> On 11. Oct 2021, at 15:47, Robert Sparks <rjsparks@nostrum.com> wrote:
>>>
>>>
>>>
>>> On 10/11/21 3:46 AM, Mirja Kuehlewind wrote:
>>>> For maprg the listing is showing up in a box and using courier 
>>>> (code style). Not sure why that is… maybe because we use “*” for 
>>>> the listing?
>>>>
>>>>
>>>> https://datatracker.ietf.org/group/maprg/about/rendertest/
>>>>
>>>>
>>>>
>>> Its because it is indented with 4 spaces in the plaintext version
>>>
>>>
>>>> gain from contacts with the IETF. The Measurement and Analysis for
>>>> Protocols Research Group Research Group (MAPRG) aims to provide a
>>>> forum for interchange between these two communities, supporting:
>>>>
>>>>      * exchange of measurement-derived insight; discussion of
>>>>        techniques and best practices for measurement relevant to
>>>>        protocol
>>>>
>>>>      * engineering and network operations;
>>>>
>>>>      * collaborations to share data supporting these measurements; and
>>>>
>>>>      * a "landing pad" for the Internet measurement community to
>>>>        introduce its efforts to the * IETF.
>>>>
>>>> Membership
>>>>
>>> which means to markdown means its a quote block.
>>>
>>>
>>>>
>>>>> On 11. Oct 2021, at 09:59, Harald Alvestrand <harald@alvestrand.no>
>>>>>   wrote:
>>>>>
>>>>> Two errors in
>>>>> https://datatracker.ietf.org/group/mediaman/about/rendertest/
>>>>>   - both due to markdown requiring a blank line before the first 
>>>>> item of a bulleted list.
>>>>>
>>>>> On 9/20/21 7:34 PM, Robert Sparks wrote:
>>>>>
>>>>>> Chairs -
>>>>>>
>>>>>> I have added a page that shows how the current charter for a 
>>>>>> group renders with markdown, comparing side-by-side with the 
>>>>>> current rendering.
>>>>>>
>>>>>> See, for example,
>>>>>> https://datatracker.ietf.org/group/stir/about/rendertest/
>>>>>>
>>>>>>
>>>>>> Please look the variant of that page for all of the groups you 
>>>>>> are responsible for (and feel free to explore others).
>>>>>>
>>>>>> Bring any issues with the markdown rendering of the current 
>>>>>> charter text to me.
>>>>>>
>>>>>> If we don't have major issues to address with any existing 
>>>>>> charter text, I plan to switch the main /about page (and the 
>>>>>> charter document view page) to render through markdown with the 
>>>>>> next datatracker release.
>>>>>>
>>>>>> RjS
>>>>>>
>>>>>>
>>>>>
>>
>