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

Mark Nottingham <mnot@mnot.net> Tue, 21 September 2021 00:05 UTC

Return-Path: <mnot@mnot.net>
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 76ED33A16EC for <wgchairs@ietfa.amsl.com>; Mon, 20 Sep 2021 17:05:57 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -2.101
X-Spam-Level:
X-Spam-Status: No, score=-2.101 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, RCVD_IN_MSPIKE_H2=-0.001, SPF_PASS=-0.001, URIBL_BLOCKED=0.001] autolearn=ham autolearn_force=no
Authentication-Results: ietfa.amsl.com (amavisd-new); dkim=pass (2048-bit key) header.d=mnot.net header.b=zhl3PDRU; dkim=pass (2048-bit key) header.d=messagingengine.com header.b=GC0Apfc/
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 hYHc_kyuMVd9 for <wgchairs@ietfa.amsl.com>; Mon, 20 Sep 2021 17:05:52 -0700 (PDT)
Received: from wout4-smtp.messagingengine.com (wout4-smtp.messagingengine.com [64.147.123.20]) (using TLSv1.2 with cipher ADH-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id D56F33A16F4 for <wgchairs@ietf.org>; Mon, 20 Sep 2021 17:05:46 -0700 (PDT)
Received: from compute2.internal (compute2.nyi.internal [10.202.2.42]) by mailout.west.internal (Postfix) with ESMTP id 166043201D59; Mon, 20 Sep 2021 20:05:45 -0400 (EDT)
Received: from mailfrontend2 ([10.202.2.163]) by compute2.internal (MEProxy); Mon, 20 Sep 2021 20:05:45 -0400
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=mnot.net; h= content-type:mime-version:subject:from:in-reply-to:date:cc :content-transfer-encoding:message-id:references:to; s=fm3; bh=l P3C5PUX9A06r2qmeL5B4Bv9CB6WzMuE5+L5IEZRWik=; b=zhl3PDRUyjMVpcax2 5B77ZcDfJGFS0HXfsKKlHxe0l4sIXZ3HlvzcasAvaNu6fG18gszDq7ehSnPZrB/R PTX6E9pmz25FgysYawLVEAd7snkhNsdp/eQy0yLiyLOKRB9UwfXp7tPDXDFgazb+ bcGN3B9IkJSD6y9ghTnrgErh7ScJf3Y1kvzDiQCzfyQIar9bEuZOuf238JnhQwus ff0ZqiW/+oj/7JdANhryRNgQOBUXtJZmPPbgLsZqm208EoDDaIHagZ3rBLIKDKTW mZJWuIsIhmhLGNPaO0nLaEWD2ozyO7p3pcROL2cE4G0//DYdgBuZDalTAqY97Dwv K/eIA==
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= messagingengine.com; h=cc:content-transfer-encoding:content-type :date:from:in-reply-to:message-id:mime-version:references :subject:to:x-me-proxy:x-me-proxy:x-me-sender:x-me-sender :x-sasl-enc; s=fm3; bh=lP3C5PUX9A06r2qmeL5B4Bv9CB6WzMuE5+L5IEZRW ik=; b=GC0Apfc/giYxocBupAjTIrIZqd5xk2F2Nr6Tv9kYIjgza58nV8bm+BtQq Wc8gHsH/BAN1ea9xe0xC/Z/6mD6xspq329IN3ASlqzT1LQmzSJ5sF7EP9+lkpfhF X4P4umrl3mvnb9thw02yhZlmPXcl75oH6Au6Z0Pb6JAOMbGBwzRDS2i3OFok5IdA LgpK5/Tgm/75PIeVL46GCbMJNnpwtVZerJrMjrmqWx8rq1M3Dgz/88DSnUUos2ki hWfPdZGw5z7V81I2f6oH9dtcWO6otX4FehyVFrXpqNgPS/AfDacCokpVwOq3Ajrf 3S6xtD363QlQtbRbyCInF3W9+/WoA==
X-ME-Sender: <xms:1iFJYXK_lbGP528L3y3lAZ9PjVIac0-qM--fQpQ7G3QVYg8GGUPY0g> <xme:1iFJYbIL0ce4oB6Cctlpc74rwHEeSA3rlPh4TlfAfyjsbe0FsLOyK8xIgU2H-7g8E u-dwOeOioTaUFoNWA>
X-ME-Received: <xmr:1iFJYfs-_P_7SpAdyjnCSg7hFEVeMt5QcCik2DieazxKG4E7u8QlW9TXZJ2M5JWEjQ5vppeh6ODfkHu4EJg5KAP6NYIPYWOpq8anvUa_SAuBXc9jNuHwogbQ>
X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgedvtddrudeifedgvdelucetufdoteggodetrfdotf fvucfrrhhofhhilhgvmecuhfgrshhtofgrihhlpdfqfgfvpdfurfetoffkrfgpnffqhgen uceurghilhhouhhtmecufedttdenucesvcftvggtihhpihgvnhhtshculddquddttddmne cujfgurheptggguffhjgffgffkfhfvofesthhqmhdthhdtvdenucfhrhhomhepofgrrhhk ucfpohhtthhinhhghhgrmhcuoehmnhhothesmhhnohhtrdhnvghtqeenucggtffrrghtth gvrhhnpeekuddvleejgeethfevkefhtdevkeelveekfeegleduiefhudegvdeiuefftddt hfenucffohhmrghinhepihgvthhfrdhorhhgpdhmnhhothdrnhgvthenucevlhhushhtvg hrufhiiigvpedtnecurfgrrhgrmhepmhgrihhlfhhrohhmpehmnhhothesmhhnohhtrdhn vght
X-ME-Proxy: <xmx:1iFJYQa_Q51D3eTAKh0f4PAaxxWWqoEr7PBVikajlx5UPyf1sNAR2A> <xmx:1iFJYeZ9Q11etHh0GDEGSintSqSjrua-JgTt5lsqmjAjM3eSp6h5mQ> <xmx:1iFJYUDbx11Lja_-hAFGnAJbGn65auRxPlYR5QijB_zM_xyU4L-5qw> <xmx:2CFJYeFo2I3Kwp0wMV0Tr96hJq_ioQXpwd5Xrn1KPuFy6yusL156sA>
Received: by mail.messagingengine.com (Postfix) with ESMTPA; Mon, 20 Sep 2021 20:05:41 -0400 (EDT)
Content-Type: text/plain; charset="us-ascii"
Mime-Version: 1.0 (Mac OS X Mail 14.0 \(3654.120.0.1.13\))
Subject: Re: Please look at your groups' charters rendered through markdown
From: Mark Nottingham <mnot@mnot.net>
In-Reply-To: <91a7eae6-6752-9c25-648a-69c4b75d600b@nostrum.com>
Date: Tue, 21 Sep 2021 10:05:37 +1000
Cc: Working Chairs <wgchairs@ietf.org>
Content-Transfer-Encoding: quoted-printable
Message-Id: <EE16E498-8A5A-49EC-8249-11F610511FD4@mnot.net>
References: <91a7eae6-6752-9c25-648a-69c4b75d600b@nostrum.com>
To: Robert Sparks <rjsparks@nostrum.com>
X-Mailer: Apple Mail (2.3654.120.0.1.13)
Archived-At: <https://mailarchive.ietf.org/arch/msg/wgchairs/JPJrXBP2UNAoTj3BTxMoZCML6zw>
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: Tue, 21 Sep 2021 00:05:58 -0000

This looks great!

The only thing I see that might be worth considering is adjusting so that when a level-1 header is used in a charter, it's appropriately sized (smaller than currently), because it's not the top-level header on the page.

IMO we should avoid lots of one-off hacks / pre-processing in the markdown -- instead, we should fix the source files.

I think you hit the nail on the head of the real issue underlying this: what flavour of md to use. Lots of people are familiar with GFM, as well as kramdown (thanks to cabo's tooling). It'd be nice not to have to mode switch to a third variety, so a subset of one of those would probably be best (assuming we're eventually going to use the same flavour across charters, minutes, agendas, etc.).

Cheers,


> On 21 Sep 2021, at 3:34 am, Robert Sparks <rjsparks@nostrum.com> 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
> 

--
Mark Nottingham   https://www.mnot.net/