IETF Logo Mail Archive

Re: document writing/editing tools used by IETF

"Salz, Rich" <rsalz@akamai.com> Mon, 01 March 2021 17:56 UTC

Return-Path: <rsalz@akamai.com>
X-Original-To: ietf@ietfa.amsl.com
Delivered-To: ietf@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id 12F0A3A2077 for <ietf@ietfa.amsl.com>; Mon, 1 Mar 2021 09:56:41 -0800 (PST)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -2.346
X-Spam-Level:
X-Spam-Status: No, score=-2.346 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.248, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, HTML_MESSAGE=0.001, SPF_HELO_NONE=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=akamai.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 nmVEqgs729-j for <ietf@ietfa.amsl.com>; Mon, 1 Mar 2021 09:56:39 -0800 (PST)
Received: from mx0b-00190b01.pphosted.com (mx0b-00190b01.pphosted.com [IPv6:2620:100:9005:57f::1]) (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 4B1E23A2073 for <ietf@ietf.org>; Mon, 1 Mar 2021 09:56:39 -0800 (PST)
Received: from pps.filterd (m0050102.ppops.net [127.0.0.1]) by m0050102.ppops.net-00190b01. (8.16.0.43/8.16.0.43) with SMTP id 121Hrc1v026906; Mon, 1 Mar 2021 17:56:34 GMT
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=akamai.com; h=from : to : cc : subject : date : message-id : references : in-reply-to : content-type : mime-version; s=jan2016.eng; bh=oG2DbHHrmVTxHRO1JzjSnbQjKA2JCQymCzEwZYU7iaA=; b=OP+6JWBuuGQVv4qC+9qb5jIHysp6ghdwEuagWfP/bWtExho0n6UJf0oqRkPpeYUcdI7s E5r/l8ocxnOwPXokVq3PEukqW+gjqpVBfuK3Gfnc5EUr2IPHmOUKjn9134F8N3Q2Nwkm nwl0OUBt60Zn1La73MUr+J4chKQAnUMRLB93Zo7O1iuCaBIR0Vk1Is+RaAsFOFt/En5v 2yNANXkRQZiEFeBCvzMxndqz32km8vaUfEgeuSivkj1Fsid/V5t1DI5U7XFAfZ8dB8Hk dcilyRC3vXt4SVLuTzoSQpvD29s6iAe5dgCFDdh5QYu/d2FL1Z3DvX2fysNEKksb+bi+ RA==
Received: from prod-mail-ppoint7 (a72-247-45-33.deploy.static.akamaitechnologies.com [72.247.45.33] (may be forged)) by m0050102.ppops.net-00190b01. with ESMTP id 36yfc378g0-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=NOT); Mon, 01 Mar 2021 17:56:34 +0000
Received: from pps.filterd (prod-mail-ppoint7.akamai.com [127.0.0.1]) by prod-mail-ppoint7.akamai.com (8.16.0.43/8.16.0.43) with SMTP id 121HnZJR031810; Mon, 1 Mar 2021 12:56:33 -0500
Received: from email.msg.corp.akamai.com ([172.27.165.115]) by prod-mail-ppoint7.akamai.com with ESMTP id 36yja48q9c-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-SHA384 bits=256 verify=NOT); Mon, 01 Mar 2021 12:56:33 -0500
Received: from USTX2EX-DAG1MB1.msg.corp.akamai.com (172.27.165.119) by ustx2ex-dag1mb4.msg.corp.akamai.com (172.27.165.122) with Microsoft SMTP Server (TLS) id 15.0.1497.2; Mon, 1 Mar 2021 11:56:32 -0600
Received: from USTX2EX-DAG1MB1.msg.corp.akamai.com ([172.27.165.119]) by ustx2ex-dag1mb1.msg.corp.akamai.com ([172.27.165.119]) with mapi id 15.00.1497.010; Mon, 1 Mar 2021 11:56:32 -0600
From: "Salz, Rich" <rsalz@akamai.com>
To: "sarikaya@ieee.org" <sarikaya@ieee.org>
CC: "ietf@ietf.org" <ietf@ietf.org>
Subject: Re: document writing/editing tools used by IETF
Thread-Topic: document writing/editing tools used by IETF
Thread-Index: AQHXC7ThDf3MYcU1AESMwtuMbZ+VHKpqCASAgAANIwCAABP/AIAATX0AgAA+QYCAAH0NAIAEghsA///NuYA=
Date: Mon, 01 Mar 2021 17:56:32 +0000
Message-ID: <F196E67F-0818-4A08-BDA5-CC57D8D6C7D4@akamai.com>
References: <37eecb9b-f0eb-e21c-b162-b1f0339e4981@si6networks.com> <3c2d646d-f18d-4d88-b458-29dbd486432b@beta.fastmail.com> <446A8D6B-E624-49E0-B67E-D1F8AFC794E2@lastpresslabel.com> <28ac1e86-f641-b9e8-0f61-6ff442feaa90@si6networks.com> <LO2P265MB057322BA95B1B44D4175356BC29E9@LO2P265MB0573.GBRP265.PROD.OUTLOOK.COM> <089096b1-10d2-3eac-d37c-f040a1930061@network-heretics.com> <37142313-C251-40DC-9336-D3A2F0FB69AD@tzi.org> <001d01d70be3$ff0972d0$fd1c5870$@acm.org> <CAMm+LwhkLTKkp3q4s97TBA-=WpJPof861mygPSjJttowpDjGuw@mail.gmail.com> <8b42a18a-181e-cad7-7333-3e950e643665@gmx.de> <C51C3823-59DA-4E61-B3A9-968BA355EEE2@depht.com> <DM6PR02MB692412D75E013F8EC314DAC6C39D9@DM6PR02MB6924.namprd02.prod.outlook.com> <CAC8QAcc7=EN_4oTNQ0eKkbwkzCUmZcfm2K1JE2C5dKwHyYT9Qg@mail.gmail.com>
In-Reply-To: <CAC8QAcc7=EN_4oTNQ0eKkbwkzCUmZcfm2K1JE2C5dKwHyYT9Qg@mail.gmail.com>
Accept-Language: en-US
Content-Language: en-US
X-MS-Has-Attach:
X-MS-TNEF-Correlator:
user-agent: Microsoft-MacOutlook/16.46.21021202
x-ms-exchange-messagesentrepresentingtype: 1
x-ms-exchange-transport-fromentityheader: Hosted
x-originating-ip: [172.27.118.139]
Content-Type: multipart/alternative; boundary="_000_F196E67F08184A08BDA5CC57D8D6C7D4akamaicom_"
MIME-Version: 1.0
X-Proofpoint-Virus-Version: vendor=fsecure engine=2.50.10434:6.0.369, 18.0.761 definitions=2021-03-01_12:2021-03-01, 2021-03-01 signatures=0
X-Proofpoint-Spam-Details: rule=notspam policy=default score=0 spamscore=0 suspectscore=0 mlxscore=0 adultscore=0 mlxlogscore=956 phishscore=0 malwarescore=0 bulkscore=0 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.12.0-2009150000 definitions=main-2103010143
X-Proofpoint-Virus-Version: vendor=fsecure engine=2.50.10434:6.0.369, 18.0.761 definitions=2021-03-01_12:2021-03-01, 2021-03-01 signatures=0
X-Proofpoint-Spam-Details: rule=notspam policy=default score=0 malwarescore=0 mlxscore=0 mlxlogscore=862 spamscore=0 adultscore=0 priorityscore=1501 phishscore=0 suspectscore=0 bulkscore=0 clxscore=1011 impostorscore=0 lowpriorityscore=0 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.12.0-2009150000 definitions=main-2103010144
X-Agari-Authentication-Results: mx.akamai.com; spf=${SPFResult} (sender IP is 72.247.45.33) smtp.mailfrom=rsalz@akamai.com smtp.helo=prod-mail-ppoint7
Archived-At: <https://mailarchive.ietf.org/arch/msg/ietf/mJUGMpoO3cQOGbgxC09awU0fs3g>
X-BeenThere: ietf@ietf.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: IETF-Discussion <ietf.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/ietf>, <mailto:ietf-request@ietf.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/ietf/>
List-Post: <mailto:ietf@ietf.org>
List-Help: <mailto:ietf-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/ietf>, <mailto:ietf-request@ietf.org?subject=subscribe>
X-List-Received-Date: Mon, 01 Mar 2021 17:56:41 -0000

  *   I never used GH like you mentioned above. I know that it is used in Quic WG and possibly others. If I understand well, it is used to create a draft in text format not in xml2rfc format,  isn't that a big negative?

QUIC, HTTP-BIS, HTTPAPI, TLS are among the groups using GitHub for drafts.  You should check it out :)

Drafts seems to usually be written in a markdown known as kramdown, and there is tooling to do kramdown->xml, and then checking, formatting, etc., and even submission of the XML to datatracker.  So, no negative.  Lots of automation thanks to https://github.com/martinthomson/i-d-template

v2.23.0 | Report a Bug | By Email