Re: [Ietf-and-github] Single repo vs organization?

Carsten Bormann <cabo@tzi.org> Thu, 16 March 2017 22:35 UTC

Return-Path: <cabo@tzi.org>
X-Original-To: ietf-and-github@ietfa.amsl.com
Delivered-To: ietf-and-github@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id 66000129B07 for <ietf-and-github@ietfa.amsl.com>; Thu, 16 Mar 2017 15:35:42 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -4.2
X-Spam-Level:
X-Spam-Status: No, score=-4.2 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, RCVD_IN_DNSWL_MED=-2.3] autolearn=ham autolearn_force=no
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 p4UK40s6BHJ9 for <ietf-and-github@ietfa.amsl.com>; Thu, 16 Mar 2017 15:35:39 -0700 (PDT)
Received: from mailhost.informatik.uni-bremen.de (mailhost.informatik.uni-bremen.de [IPv6:2001:638:708:30c9::12]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 74A2A129B10 for <ietf-and-github@ietf.org>; Thu, 16 Mar 2017 15:35:39 -0700 (PDT)
X-Virus-Scanned: amavisd-new at informatik.uni-bremen.de
Received: from submithost.informatik.uni-bremen.de (submithost.informatik.uni-bremen.de [IPv6:2001:638:708:30c9::b]) by mailhost.informatik.uni-bremen.de (8.14.5/8.14.5) with ESMTP id v2GMZX8B013222; Thu, 16 Mar 2017 23:35:33 +0100 (CET)
Received: from [192.168.217.124] (p5DCCCDC2.dip0.t-ipconnect.de [93.204.205.194]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by submithost.informatik.uni-bremen.de (Postfix) with ESMTPSA id 3vkjwj3cnXzDGx4; Thu, 16 Mar 2017 23:35:33 +0100 (CET)
Content-Type: text/plain; charset="utf-8"
Mime-Version: 1.0 (Mac OS X Mail 10.2 \(3259\))
From: Carsten Bormann <cabo@tzi.org>
In-Reply-To: <182C3216-14F6-4D29-AF6B-54FAF71666E8@mnot.net>
Date: Thu, 16 Mar 2017 23:35:32 +0100
Cc: Brian E Carpenter <brian.e.carpenter@gmail.com>, ietf-and-github@ietf.org
X-Mao-Original-Outgoing-Id: 511396532.759017-014b0a425e301ffb09e17e100d85f7b5
Content-Transfer-Encoding: quoted-printable
Message-Id: <46A5629D-57F0-4F39-BE8C-5E94CA67C404@tzi.org>
References: <B1A0A921-3034-45B7-BE70-6490BA95A6D7@vpnc.org> <CABkgnnX6Qqhe6D63npbwxUVXa5sOY9AdZ9Ew5Jnb39rY-npjdg@mail.gmail.com> <F3CC8F03-1B28-4944-AFA4-A742B02FC8A0@mnot.net> <b1c4f37b-c6b5-ac29-5d2e-28c57a988a0d@gmail.com> <182C3216-14F6-4D29-AF6B-54FAF71666E8@mnot.net>
To: Mark Nottingham <mnot@mnot.net>
X-Mailer: Apple Mail (2.3259)
Archived-At: <https://mailarchive.ietf.org/arch/msg/ietf-and-github/0FEPCZO53BKjuQkw31nTokBlCEA>
Subject: Re: [Ietf-and-github] Single repo vs organization?
X-BeenThere: ietf-and-github@ietf.org
X-Mailman-Version: 2.1.22
Precedence: list
List-Id: "Discussion of using GitHub in IETF activities, particularly for Working Groups" <ietf-and-github.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/ietf-and-github>, <mailto:ietf-and-github-request@ietf.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/ietf-and-github/>
List-Post: <mailto:ietf-and-github@ietf.org>
List-Help: <mailto:ietf-and-github-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/ietf-and-github>, <mailto:ietf-and-github-request@ietf.org?subject=subscribe>
X-List-Received-Date: Thu, 16 Mar 2017 22:35:42 -0000

+1 for all of the below.

One repo per draft, all of which are in a per-WG organization, is the default model for the groups I’m chairing/advising on this.  (Yes, Martin’s template helps, but I get at least one detail wrong each time I set one up.  Takes about 30 min per repo; could be much faster with some more tooling.)

We tried multiple drafts per repo for CoRE's COMI cluster (interrelated drafts again).  Kind of worked, but maybe our drafts weren’t that much interrelated.
A multi-draft repo may also have a very large team so it becomes harder to know who should be doing what.

One repo per draft probably also is more accessible for external observers.

My most recent PR for Lars’ original draft about github said:

+For most repos, a CI (continuous integration) process is set up that
+generates a readable editor's copy (in HTML form) as well as a diff
+from the most recent submitted version (tools TXT diff), linked from
+the README; both have turned out to be very valuable.  (Unfortunately, the
+travis-based CI process is somewhat brittle, so there is an
+appreciable failure rate.)

The github.io page resulting from the CI is less confusing for a single-draft repo.

(As discussed, github-savvy authors sometimes get lazy pushing drafts into I-Ds again.  This may lead to extended work happening on github only.  Not good.  The tools TXT diff is really useful as long as it does not have to explain multiple reorganizations of the document.)

We also have a few drafts in individual’s github accounts.  This is much less accessible.
I generally favor moving drafts into the WG organization even *before* they become adopted WG drafts.  That may be slightly confusing for outsiders (might get the idea something is adopted that isn’t), but gets people primed on the issues/PR process even before adoption.

Grüße, Carsten


> On 16 Mar 2017, at 23:11, Mark Nottingham <mnot@mnot.net> wrote:
> 
> From an end user perspective, having a single-repo-per-draft is preferable; it means you can easily subscribe to updates for just that draft, and don't have extraneous notifications, etc. The repo itself has less information it in as well (naturally), meaning there's less overhead for clones, etc.
> 
> However, creating a repo-per-draft has more administrative overhead. Martin's template repo takes a fair amount of pain out of it, but making sure that things like README, CONTRIBUTING, e-mail notifications to a list, permissions, etc. etc. are set up correctly is not trivial. 
> 
> Personally, I'm less concerned about the amount of work than I am about the risk of getting something wrong on some repo and not noticing.
> 
> Having said that, I think if we were starting HTTPbis from scratch right now, we'd do a repo-per-draft.
> 
> One caveat -- I think there's agreement that in at least one situation, more than one repo-per-draft is preferable. That's when there is a set of highly interrelated drafts that are likely to share issues, and possibly have text migrate between them. We consciously made this decision for the QUIC drafts.
> 
> Cheers,
> 
> 
> 
>> On 17 Mar 2017, at 1:20 am, Brian E Carpenter <brian.e.carpenter@gmail.com> wrote:
>> 
>> So could somebody with experience set out the pros and cons of
>> (a single repo per WG) vs (an 'organization' with a repo per draft)?
>> 
>> Regards
>>  Brian
>> 
>> On 16/03/2017 18:49, Mark Nottingham wrote:
>>> 
>>>> On 16 Mar 2017, at 4:25 pm, Martin Thomson <martin.thomson@gmail.com> wrote:
>>>> 
>>>> HTTPBIS - all working group drafts are in a single repo (this is not
>>>> working out great
>>> 
>>> yes, we know you have an axe to grind...
>>> 
>>>> ) and all issues are tracked there; discussion is on
>>>> github; materials like agendas and meeting arrangements are on github
>>>> too
>>> 
>>> Also WG home page -- <https://httpwg.github.io/>.
>>> 
>>> 
>>> --
>>> Mark Nottingham   https://www.mnot.net/
>>> 
>>> _______________________________________________
>>> Ietf-and-github mailing list
>>> Ietf-and-github@ietf.org
>>> https://www.ietf.org/mailman/listinfo/ietf-and-github
>>> .
>>> 
>> 
>> _______________________________________________
>> Ietf-and-github mailing list
>> Ietf-and-github@ietf.org
>> https://www.ietf.org/mailman/listinfo/ietf-and-github
> 
> --
> Mark Nottingham   https://www.mnot.net/
> 
> _______________________________________________
> Ietf-and-github mailing list
> Ietf-and-github@ietf.org
> https://www.ietf.org/mailman/listinfo/ietf-and-github
>