Re: [yang-doctors] YANG draft development with markdown

Martin Bjorklund <mbj@tail-f.com> Mon, 05 March 2018 13:33 UTC

Return-Path: <mbj@tail-f.com>
X-Original-To: yang-doctors@ietfa.amsl.com
Delivered-To: yang-doctors@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id B6BA112D778 for <yang-doctors@ietfa.amsl.com>; Mon, 5 Mar 2018 05:33:54 -0800 (PST)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -1.91
X-Spam-Level:
X-Spam-Status: No, score=-1.91 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, SPF_PASS=-0.001, T_RP_MATCHES_RCVD=-0.01, URIBL_BLOCKED=0.001] 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 6QX1S42l87cD for <yang-doctors@ietfa.amsl.com>; Mon, 5 Mar 2018 05:33:53 -0800 (PST)
Received: from mail.tail-f.com (mail.tail-f.com [46.21.102.45]) by ietfa.amsl.com (Postfix) with ESMTP id 0B8C7120454 for <yang-doctors@ietf.org>; Mon, 5 Mar 2018 05:33:52 -0800 (PST)
Received: from localhost (unknown [173.38.220.45]) by mail.tail-f.com (Postfix) with ESMTPSA id 24A791AE02EF; Mon, 5 Mar 2018 14:33:51 +0100 (CET)
Date: Mon, 05 Mar 2018 14:33:50 +0100
Message-Id: <20180305.143350.1574953054173250656.mbj@tail-f.com>
To: lear@cisco.com
Cc: yang-doctors@ietf.org
From: Martin Bjorklund <mbj@tail-f.com>
In-Reply-To: <da08c294-ff92-9457-8b3b-ba0c0d0d83b6@cisco.com>
References: <da08c294-ff92-9457-8b3b-ba0c0d0d83b6@cisco.com>
X-Mailer: Mew version 6.7 on Emacs 24.5 / Mule 6.0 (HANACHIRUSATO)
Mime-Version: 1.0
Content-Type: Text/Plain; charset="iso-8859-1"
Content-Transfer-Encoding: quoted-printable
Archived-At: <https://mailarchive.ietf.org/arch/msg/yang-doctors/sVGfdAZ07URJlPkM6Iqo0alj_6U>
Subject: Re: [yang-doctors] YANG draft development with markdown
X-BeenThere: yang-doctors@ietf.org
X-Mailman-Version: 2.1.22
Precedence: list
List-Id: Email list of the yang-doctors directorate <yang-doctors.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/yang-doctors>, <mailto:yang-doctors-request@ietf.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/yang-doctors/>
List-Post: <mailto:yang-doctors@ietf.org>
List-Help: <mailto:yang-doctors-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/yang-doctors>, <mailto:yang-doctors-request@ietf.org?subject=subscribe>
X-List-Received-Date: Mon, 05 Mar 2018 13:33:55 -0000

Hi,

Eliot Lear <lear@cisco.com> wrote:
> Dear Doctors,
> 
> I am in the process of writing a draft with a YANG module in MD, and I
> use kramdown-2629 to generate XML.  Here is the question:
> 
>   * Is there a preferred draft development approach where YANG models
>     are incorporated/included in that particular process?

I don't know the answer to this question, so I'll answer a question
you didn't ask :)

Many of us use an alternative tool, called "oxtradoc", found at:
https://github.com/Juniper/libslax.

As an example, see https://github.com/netmod-wg/rfc7223bis.

YANG modules and examples are written in separate files (which can be
validated with tools), and included using a special instruction in the
oxtradoc syntax.



/martin