Re: Proposal to migrate from QUIC GitHub wikis to quicwg.org

Lucas Pardue <lucas@lucaspardue.com> Tue, 30 July 2024 14:39 UTC

Return-Path: <lucas@lucaspardue.com>
X-Original-To: quic@ietfa.amsl.com
Delivered-To: quic@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id 5A24BC14F71B for <quic@ietfa.amsl.com>; Tue, 30 Jul 2024 07:39:46 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -2.104
X-Spam-Level:
X-Spam-Status: No, score=-2.104 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, HTML_MESSAGE=0.001, RCVD_IN_MSPIKE_H4=0.001, RCVD_IN_MSPIKE_WL=0.001, RCVD_IN_ZEN_BLOCKED_OPENDNS=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01, URIBL_BLOCKED=0.001, URIBL_DBL_BLOCKED_OPENDNS=0.001, URIBL_ZEN_BLOCKED_OPENDNS=0.001] autolearn=ham autolearn_force=no
Authentication-Results: ietfa.amsl.com (amavisd-new); dkim=pass (2048-bit key) header.d=lucaspardue.com header.b="t58BDKTW"; dkim=pass (2048-bit key) header.d=messagingengine.com header.b="ul2MsqfW"
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 OvDNyi75ymHH for <quic@ietfa.amsl.com>; Tue, 30 Jul 2024 07:39:41 -0700 (PDT)
Received: from fout2-smtp.messagingengine.com (fout2-smtp.messagingengine.com [103.168.172.145]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature ECDSA (P-256) server-digest SHA256) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 6F4A0C14F70C for <quic@ietf.org>; Tue, 30 Jul 2024 07:39:41 -0700 (PDT)
Received: from compute4.internal (compute4.nyi.internal [10.202.2.44]) by mailfout.nyi.internal (Postfix) with ESMTP id 90938138023A; Tue, 30 Jul 2024 10:39:40 -0400 (EDT)
Received: from wimap26 ([10.202.2.86]) by compute4.internal (MEProxy); Tue, 30 Jul 2024 10:39:40 -0400
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=lucaspardue.com; h=cc:cc:content-type:content-type:date:date:from:from :in-reply-to:in-reply-to:message-id:mime-version:references :reply-to:subject:subject:to:to; s=fm1; t=1722350380; x= 1722436780; bh=8B6as9v22rCTkM2esAqtANvJgSrTXk6w+nX2acn24RM=; b=t 58BDKTWV1Sw2BgJM4Q0oVzx0H1kn0XgceBVAm/GBmSlaJBVJVdqW7YVihQcXDf6b EemZY/f1/74Yd988KZU8rRdaiAnHjOPqx7w2+rjwxmJ+fO63QPj9+4S/4rk58chm 99YMwDUw5dRIWCGHXQD7q4Ht3k7RnMeXb0hHeJvJiDdh3opbUBer40T7jVPoANI5 Y6JGx5YvYGox1ocNDl1c21D7RqRkqJSCdJWRgFM663VnYlazmLYTv0TNGEPWsuNI r8qLImPFVuiShXYHC14GQOIOMgKeEINuhvA1EmFl5pg9zzZpY1a8lNFY2/1sID/8 iscvOAbna2brulDMoxWig==
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= messagingengine.com; h=cc:cc:content-type:content-type:date:date :feedback-id:feedback-id:from:from:in-reply-to:in-reply-to :message-id:mime-version:references:reply-to:subject:subject:to :to:x-me-proxy:x-me-proxy:x-me-sender:x-me-sender:x-sasl-enc; s= fm3; t=1722350380; x=1722436780; bh=8B6as9v22rCTkM2esAqtANvJgSrT Xk6w+nX2acn24RM=; b=ul2MsqfWNuBdsPIzGLGMhoY8OFKOW32NoI76xoFeAiFA 8fAYpqRfI56vi3o2qy951M1grQJWXITLDVBdxDKiIwSX9lrb8fJ8QbhZo5Nl7SBk 09FCkNv0D4aZ3rb0/h39gA5kPAgsghbom3z1UHVbg/COTQUdYMiPt1jhoFsaejB/ LR1lrmQiCyzhNQacgRf9RvSHZ6vA1xt+wCNzIG3MBfbH3Dec7eCKkypH67/3cVLd 41im+SgBWOVvz8Cj0qH3S6UXK/mUIUZiwSRzMGOXQlSR9O2TJO1MU5QYbyaQ73MD HqORPbEBgmFG/lIAqzA6FW5aLtep5Z10gCQnOV6OdA==
X-ME-Sender: <xms:LPuoZoQJAexJyQBHrIi5m7e1YyRQwbCpXZsUyEt-4Xv2rIfw40szVg> <xme:LPuoZlzBo_D8-J4RaNx3ZHqS9YLoOha8DFNliLFCCN5sregnix5CPPe31KOkkq0Mw C-bPDWzwFXMRPR8Emk>
X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgeeftddrjeeggdektdcutefuodetggdotefrodftvf curfhrohhfihhlvgemucfhrghsthforghilhdpqfgfvfdpuffrtefokffrpgfnqfghnecu uegrihhlohhuthemuceftddtnecuogfuuhhsphgvtghtffhomhgrihhnucdlgeelmdenuc fjughrpefoggffhffvvefkjghfufgtsegrtderreertdejnecuhfhrohhmpedfnfhutggr shcurfgrrhguuhgvfdcuoehluhgtrghssehluhgtrghsphgrrhguuhgvrdgtohhmqeenuc ggtffrrghtthgvrhhnpedvffeuveehveegueejjedtieejtdfgieelledtveeggfdtfeev geffhfffieduffenucffohhmrghinhepqhhuihgtfihgrdhorhhgpdhivghtfhdrohhrgh dpghhithhhuhgsrdgtohhmpdhgihhthhhusgdrihhonecuvehluhhsthgvrhfuihiivgep tdenucfrrghrrghmpehmrghilhhfrhhomheplhhutggrsheslhhutggrshhprghrughuvg drtghomhdpnhgspghrtghpthhtoheptd
X-ME-Proxy: <xmx:LPuoZl1UopUAi_Bsze4H2a-rnFT1a_i94c1Y_jYhsv1tvzTyKUdScw> <xmx:LPuoZsDliD4MH5eyJzz-kfaACxsQpseHCYixJXxshle3PxQuW4b15w> <xmx:LPuoZhgX-CeVZ3pKU33Uu2Xz36y6eYkHPyf6KL83sfNONYFf95ZrYA> <xmx:LPuoZooBaIQSN5EcYDj4gSf_NeoHgaCqulOM7E4-3X7epPRACftEew> <xmx:LPuoZhbpbqa-xxxUMvuhsbSh3LQ3-o1eAApWXx2kOI5HzaBdCyKfXU0u>
Feedback-ID: i23b94938:Fastmail
Received: by mailuser.nyi.internal (Postfix, from userid 501) id 5878419C0069; Tue, 30 Jul 2024 10:39:40 -0400 (EDT)
X-Mailer: MessagingEngine.com Webmail Interface
MIME-Version: 1.0
Date: Tue, 30 Jul 2024 15:39:19 +0100
From: Lucas Pardue <lucas@lucaspardue.com>
To: Ted Hardie <ted.ietf@gmail.com>
Message-Id: <b30316a4-7a7d-467f-8b61-a08bfc100ad5@app.fastmail.com>
In-Reply-To: <CA+9kkMA5x4X8ZgY1ENK2QvpFcFLfMQ6Fn9amffPCzYWT-hZvMA@mail.gmail.com>
References: <24f54137-c806-405d-8e62-235ccaad1b2a@app.fastmail.com> <CA+9kkMDTYeVvkPMHXz7EsNbO1qB0ArYnnFrCxio8X2QJGfjGfA@mail.gmail.com> <f3c381cc-8603-40f2-958e-333bba8bf1ef@app.fastmail.com> <CA+9kkMA5x4X8ZgY1ENK2QvpFcFLfMQ6Fn9amffPCzYWT-hZvMA@mail.gmail.com>
Subject: Re: Proposal to migrate from QUIC GitHub wikis to quicwg.org
Content-Type: multipart/alternative; boundary="e64376e2a05d48cfadc37046478ff1ff"
Message-ID-Hash: 2VEM4IOVJ7J2BKUX7IC6Q4S3NC43KHQQ
X-Message-ID-Hash: 2VEM4IOVJ7J2BKUX7IC6Q4S3NC43KHQQ
X-MailFrom: lucas@lucaspardue.com
X-Mailman-Rule-Misses: dmarc-mitigation; no-senders; approved; emergency; loop; banned-address; member-moderation; header-match-quic.ietf.org-0; nonmember-moderation; administrivia; implicit-dest; max-recipients; max-size; news-moderation; no-subject; digests; suspicious-header
CC: quic@ietf.org
X-Mailman-Version: 3.3.9rc4
Precedence: list
List-Id: Main mailing list of the IETF QUIC working group <quic.ietf.org>
Archived-At: <https://mailarchive.ietf.org/arch/msg/quic/CyPBB0d6oKS5j6E3mFQn32bwgN4>
List-Archive: <https://mailarchive.ietf.org/arch/browse/quic>
List-Help: <mailto:quic-request@ietf.org?subject=help>
List-Owner: <mailto:quic-owner@ietf.org>
List-Post: <mailto:quic@ietf.org>
List-Subscribe: <mailto:quic-join@ietf.org>
List-Unsubscribe: <mailto:quic-leave@ietf.org>

Hi Ted,

On Tue, Jul 30, 2024, at 14:42, Ted Hardie wrote:
> Hi Lucas,
> 
> Thanks for the reply.  Given that reply, I think it would make sense for the wg to see a more worked description of how the contribution mechanics would work.
As noted in my original email, my intention would be to follow the similar ways in how we use Github for drafts and wg-materials (minutes, slides, etc) using Issues and PRs. 

I do not envisage the Web pages to contain resources that are formal WG items that requires consensus. We can and do link to those already on the appropriate datatracker and/or RFC editor pages.

The chairs are already the party primarily responsible for triaging issues, reviewing PRs, and updating the quicwg.org source repo. Putting further content there seems like a natural extension to me. The goal would be a very light-touch process, focused primarily on not breaking things and maintaining a consistent style.

> 
>   At the moment, updating the wiki requires certain permissions for the repo; if the end state after you've worked this out is functionally the same, then this change doesn't really improve things and can probably be safely put aside.

The kicker is, GitHub wikis are just a (poor) UI layer over markdown files in a repo. Something many contributors, or would be contributors, are already familiar with. Sadly, 
the GitHub wiki appears to lack any form of access control, change control, review process or curation. To my knowledge, it is not even possible for somebody to easily propose an edit and allow the repo maintainer to vet it. This is pretty much the complete opposite to how the QUIC WG has used GitHub since day 1. 

> 
> 
>   If there is a way to do this that allows "useful grass roots contribution and maintenance" without similar permissions, it would be useful for the working group to understand it when making this decision and also to document that for other groups that might have similar issues.
No hats: I struggle to see how completely free write access can work. Even the IETF's own wiki service at wiki.ietf.org has edit access controls based on datatracker login or by filing a GitHub pull request.

When the wiki is vandalised, the only folks that can fix it are the people with write access. Ultimately that tends to land on the chairs to do. I think it's fair to prevent intentional or accidental damage before it happens, rather than to spend cycles tidying up. We were lucky that the vandalism was somewhat benign data deletion, it could have been something worse.

None of the status quo is really documented as it evolved organically. Any changes are an ideal time to write more concrete ideas and processes down. I suspect the best format for doing that is a staging version of the website with some placeholder content. 

An alternative could be to migrate GitHub wiki content to e.g. wiki.ietf.org/en/group/quic. However, I'm not sure that addresses all of the pain points. And it will mean we still have content split between the quicwg.org landing page and a wiki.

Another alternative is, of course, to do nothing and just leave things frozen as they are. I don't think that's a particularly good outcome for anyone though. 

Cheers
Lucas
> 
> Just my personal opinion, of course,
> 
> Ted Hardie
> 
> On Tue, Jul 30, 2024 at 10:36 AM Lucas Pardue <lucas@lucaspardue.com> wrote:
>> __
>> Hi Ted,
>> 
>> On Tue, Jul 30, 2024, at 10:15, Ted Hardie wrote:
>>> Hi Lucas,
>>> 
>>> I think I am missing something fundamental here:
>>> 
>>> I'd like to propose that we migrate away from using GitHub wikis for all repositories in the quicwg org, towards using the quicwg.org pages. This is intended to improve the contribution and change process. It is hoped that this will also improve the discoverability of content on the wiki. During any migration, content will continue to reside on the wiki.
>>> 
>>> There is nothing on those pages that I could see that indicates how you can propose a change to the pages.  If the aim here is to enable "useful grass roots contribution and maintenance.", I think it would be appropriate to say more about how this migration does that, because I don't understand it.  The quicwg website doesn't even indicate how to contact the maintainers, so it's hard to see how it enables a grassroots effort.
>> Indeed, the current quicwg.org has been mostly operated by the chairs, with a small number of contributions from those that might have stumbled on the repo.
>> 
>> Consolidating useful information to a single place would come with improving the documentation on how to contribute, whether it be an issue or a PR to the repo [1]. And of course, we would cover the requisite notes on contribution code of conduct and note well.
>> 
>> Cheers
>> Lucas
>> 
>> [1] https://github.com/quicwg/quicwg.github.io
>>