Re: [Tools-discuss] Template repository for GitHub

Robert Sparks <rjsparks@nostrum.com> Tue, 20 July 2021 22:16 UTC

Return-Path: <rjsparks@nostrum.com>
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 A4E0F3A3467 for <tools-discuss@ietfa.amsl.com>; Tue, 20 Jul 2021 15:16:37 -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_PERMERROR=0.01, T_SPF_TEMPERROR=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 ND-59W0Po55P for <tools-discuss@ietfa.amsl.com>; Tue, 20 Jul 2021 15:16:31 -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 491633A3468 for <tools-discuss@ietf.org>; Tue, 20 Jul 2021 15:16:31 -0700 (PDT)
Received: from unformal.localdomain ([47.186.34.206]) (authenticated bits=0) by nostrum.com (8.16.1/8.16.1) with ESMTPSA id 16KMGOK4066344 (version=TLSv1.3 cipher=TLS_AES_256_GCM_SHA384 bits=256 verify=NO); Tue, 20 Jul 2021 17:16:25 -0500 (CDT) (envelope-from rjsparks@nostrum.com)
DKIM-Signature: v=1; a=rsa-sha256; c=simple/simple; d=nostrum.com; s=default; t=1626819385; bh=cByxR1mzz/d6quriVz9AOfA942l0+9niUZXybmb9H1k=; h=To:References:From:Subject:Date:In-Reply-To; b=eLHrq5tIdhPKLVEA7KfBOoqgZXQyuZ2iD3jP8iEVcXs4hGHJkvC15fEG1oOrIEHhi p1kAScgcslRlrbZPiUWCab/nFjlFV6+w43Olk+ZIPed5iolCovoOWpCDgHjBPdaOzs ro0Sqqhyux1qqzz75rM3+pHZeofbeozBp1/YYzDg=
X-Authentication-Warning: raven.nostrum.com: Host [47.186.34.206] claimed to be unformal.localdomain
To: Martin Thomson <mt@lowentropy.net>, tools-discuss@ietf.org
References: <5391988e-7180-49d3-989b-3cf40e395408@www.fastmail.com>
From: Robert Sparks <rjsparks@nostrum.com>
Message-ID: <da3ef933-0a21-c596-efeb-016333c7e4db@nostrum.com>
Date: Tue, 20 Jul 2021 17:16:19 -0500
User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:78.0) Gecko/20100101 Thunderbird/78.12.0
MIME-Version: 1.0
In-Reply-To: <5391988e-7180-49d3-989b-3cf40e395408@www.fastmail.com>
Content-Type: text/plain; charset=utf-8; format=flowed
Content-Transfer-Encoding: quoted-printable
Content-Language: en-US
Archived-At: <https://mailarchive.ietf.org/arch/msg/tools-discuss/Hp69gQdzNv-SnJZsSL_Dik3QQJE>
Subject: Re: [Tools-discuss] Template repository for GitHub
X-BeenThere: tools-discuss@ietf.org
X-Mailman-Version: 2.1.29
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: Tue, 20 Jul 2021 22:16:38 -0000

Martin -

I tried to pretend I didn't know anything about IDs and started a new 
draft using this template, making some notes along the way. I'll share 
them here before they're lost. I don't think any of the points are quite 
cooked enough to go in as Issues, but if so, feel free to just transcode 
them or tell me to do so.

* A new person won't know about the -latest convention. Something should 
be really obvious in the startup that tells them to leave that part of 
the name alone (maybe as a comment block in the template?)

* Is it possible to have an initial workflow that asks the new author 
for the draft name and target wg at least and does the initial 
alteration of the template md for them, waiting to start the other 
actions (that would build that md) until that's already been done?

* Something that made it quickly clear what the stuff (kramdown-2629 
input) in the .md template is would help - I think a complete new person 
won't be able to find that soon enough to not walk away

* The enabling github pages step is not intuitive to github newbies. I 
don't know if there's enough control that an action could do that for 
them? (maybe that's on the other side of "get an api key"). If not, 
perhaps the documentation example could show the place they should touch 
in the default theme, and maybe words-circles-and-arrows to help with 
the handholding.

* The run fail messages are really going to scare someone new (to 
github) away. Maybe the above suggestion can help people avoid them.

* Would it be useful to start a "something broke, how do I fix it" FAQ? 
For instance, when I tried, the submission window was closed, so 
creating a release led to an expected failure. I've done this enough to 
know that I can delete that release and try to make another one when the 
window opens, but I don't think someone new would know to try that? 
Maybe the submission step could delete the release for them if the API 
returns an error? (Won't help for the "some other author cancelled the 
submission" possibility).

* I wonder when we should abstract the template examples away from real 
people? (Has Hannes ever had to reject (or otherwise chase) something he 
wasn't actually invovled in?)

* It will take someone awhile to find .note.xml and know what to do with 
it. The setup for a non-wg submission isn't obvious - maybe it could be 
made simpler for a complete newcomer?

RjS

On 7/15/21 10:14 PM, Martin Thomson wrote:
> Hey,
>
> Anyone who has setup a new GitHub repository for an Internet-Draft knows that it can be a little tricky, particularly if you use the toolchain I support.
>
> Not any more.  I've created a template repository that makes setup very simple.  Just create a new repository using the template, rename your draft, enable GitHub Pages, and you are ready to go.
>
> You can run all of this from the web UI that GitHub provides.  That includes publishing drafts to datatracker, which is done by creating a release[*].
>
> Some credit here is owed to Mallory Knodel for complaining loudly enough about how unfriendly this whole setup was and motivating me to spend a couple of hours on finally doing this.
>
> Documentation here:
> https://github.com/martinthomson/i-d-template/blob/main/doc/TEMPLATE.md
>
> As always contributions and bug reports are welcome.
>
> Cheers,
> Martin
>
> [*] This bit isn't completely tested yet, I'll confess.
>
> ___________________________________________________________
> Tools-discuss mailing list - 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
> * Report tools.ietf.org bugs to: webmaster@tools.ietf.org
> * Report all other bugs or issues to: ietf-action@ietf.org
> List info (including how to Unsubscribe): https://www.ietf.org/mailman/listinfo/tools-discuss