Re: [Emo-dir] quick-start guides

Toerless Eckert <tte@cs.fau.de> Wed, 02 February 2022 18:14 UTC

Return-Path: <eckert@i4.informatik.uni-erlangen.de>
X-Original-To: emo-dir@ietfa.amsl.com
Delivered-To: emo-dir@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id 9A7AD3A18E6; Wed, 2 Feb 2022 10:14:02 -0800 (PST)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -0.868
X-Spam-Level:
X-Spam-Status: No, score=-0.868 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, HEADER_FROM_DIFFERENT_DOMAINS=0.25, RCVD_IN_DNSWL_BLOCKED=0.001, SPF_HELO_NONE=0.001, SPF_NEUTRAL=0.779, URIBL_BLOCKED=0.001] autolearn=no 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 2HsSKHKmXB90; Wed, 2 Feb 2022 10:13:58 -0800 (PST)
Received: from faui40.informatik.uni-erlangen.de (faui40.informatik.uni-erlangen.de [IPv6:2001:638:a000:4134::ffff:40]) (using TLSv1.2 with cipher ADH-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 3A9E53A18DE; Wed, 2 Feb 2022 10:13:56 -0800 (PST)
Received: from faui48e.informatik.uni-erlangen.de (faui48e.informatik.uni-erlangen.de [IPv6:2001:638:a000:4134::ffff:51]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (No client certificate requested) by faui40.informatik.uni-erlangen.de (Postfix) with ESMTPS id 03EF758C4B4; Wed, 2 Feb 2022 19:13:48 +0100 (CET)
Received: by faui48e.informatik.uni-erlangen.de (Postfix, from userid 10463) id E4A9A4EA536; Wed, 2 Feb 2022 19:13:47 +0100 (CET)
Date: Wed, 02 Feb 2022 19:13:47 +0100
From: Toerless Eckert <tte@cs.fau.de>
To: Andrew Campling <andrew.campling@419.consulting>
Cc: Karen O'Donoghue <odonoghue@isoc.org>, Mirja Kuehlewind <ietf@kuehlewind.net>, Carsten Bormann <cabo@tzi.org>, "Salz, Rich" <rsalz@akamai.com>, "emo-dir@ietf.org" <emo-dir@ietf.org>, Alice Russo <arusso@amsl.com>, Jay Daley <exec-director@ietf.org>, Lars Eggert <lars@eggert.org>
Message-ID: <YfrJ2yQ9FPG6U9bH@faui48e.informatik.uni-erlangen.de>
References: <51F3DD06-DA88-4DBD-ABBA-1CD0972326A4@amsl.com> <2FBDEFE9-CE5B-4CD3-BE20-670056E836A4@eggert.org> <3EADD8F6-8AC9-444D-B69A-063A9C5E24FA@ietf.org> <BC17F589-5CBA-4DF6-AEC3-FBCA1CE66168@akamai.com> <3819AF79-DEEB-470F-92E1-C279AE3205E6@tzi.org> <6BD7B194-BFF3-41B5-A6E5-FEC90F6EF095@kuehlewind.net> <E6F8DF68-04D8-4CA2-952C-AA554A9D36B8@tzi.org> <AC30DA05-96BD-407A-B36A-ACABF65B21F2@kuehlewind.net> <PH0PR06MB70611788BB39736280D9C799C2279@PH0PR06MB7061.namprd06.prod.outlook.com> <LO3P265MB2092E40771B158DE7737DB75C2279@LO3P265MB2092.GBRP265.PROD.OUTLOOK.COM>
MIME-Version: 1.0
Content-Type: text/plain; charset="us-ascii"
Content-Disposition: inline
In-Reply-To: <LO3P265MB2092E40771B158DE7737DB75C2279@LO3P265MB2092.GBRP265.PROD.OUTLOOK.COM>
Archived-At: <https://mailarchive.ietf.org/arch/msg/emo-dir/fCIxSPM2Ofiou0Y4zhwrVI8uSxA>
Subject: Re: [Emo-dir] quick-start guides
X-BeenThere: emo-dir@ietf.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: "Education, Mentoring & Outreach Directorate" <emo-dir.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/emo-dir>, <mailto:emo-dir-request@ietf.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/emo-dir/>
List-Post: <mailto:emo-dir@ietf.org>
List-Help: <mailto:emo-dir-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/emo-dir>, <mailto:emo-dir-request@ietf.org?subject=subscribe>
X-List-Received-Date: Wed, 02 Feb 2022 18:14:03 -0000

I think the first target is authors familiar with nothing writing new draft.
  -> kramdown over the web

Second target is IMHO technical authors familiar with nothing joining an existing XML draft.
  -> XML over the web.

Third target is technical authors that need to be able to work offline
  (planes, trains, offices (with bad firewalls), beaches, etc. pp).
  -> local install of kramdown, xml2rfc - and i fear references libraries.

Everything else is IMHO below the first success goal line
(but then i am intentionally thinking someone who can already do github can
 help herself a lot more than above audiences...)

Cheers
    Toerless

On Wed, Feb 02, 2022 at 04:57:08PM +0000, Andrew Campling wrote:
> On 2 Feb 2022, at 14:32, Karen O'Donoghue odonoghue@isoc.org<mailto:odonoghue@isoc.org> wrote:
> 
> > I strongly agree with Mirja here. The problem we were discussing last week was how to help people get started... quickly... without overwhelming them with options and choices. I think we need a very limited set of choices in this instance. At the end of the short quick start guides... we can point to more information and detailed instructions elsewhere.
> >
> > Remember this can always evolve as we learn more. Done is better than perfect.
> 
> 
> I agree that the emphasis should be on simplicity, although I can see the temptation to offer multiple options given there are different types of new authors that may benefit from this guidance.  To simplify things, it may be useful to have something like:
> 
> "Software developers familiar with GitHub should start here ... (a single path with as few steps as possible to get to draft submission)
> 
> Technical authors with experience of markdown should start here ...
> 
> Technical authors familiar with XML should start here ... "
> 
> Etc
> 
> No doubt agreement on appropriate labels for the various categories will need discussion, the idea would be to point to a single path for each one from start to finish, potentially signposting additional material at the end such as more sophisticated templates and tools for those that aspire to more advanced documents.  NB I think that we should be cautious with paths that are dependent on tools being loaded onto devices as this may present a problem for some enterprise policies, although this should be fine as part of a list of additional material and tools.
> 
> We are still missing something suited to less sophisticated potential authors that may nevertheless be able to offer valuable contributions including, for example, those from civil society, industry bodies and other groups of end-users not versed in the use of GitHub, Markdown etc.  The current options are still likely to be perceived as a significant barrier to entry for some compared to, for example, a step-by-step guide to producing an I-D using Word.  Others may disagree but I firmly believe it is important to make it possible for such groups to participate if the IETF is to diversify the membership beyond the tech and telecoms sectors.
> 
> 
> Andrew
> 
> 
> 

> _______________________________________________
> Emo-dir mailing list
> Emo-dir@ietf.org
> https://www.ietf.org/mailman/listinfo/emo-dir


-- 
---
tte@cs.fau.de