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

Mahesh Jethanandani <mjethanandani@gmail.com> Tue, 06 March 2018 01:22 UTC

Return-Path: <mjethanandani@gmail.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 18B13126DD9 for <yang-doctors@ietfa.amsl.com>; Mon, 5 Mar 2018 17:22:43 -0800 (PST)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -2
X-Spam-Level:
X-Spam-Status: No, score=-2 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, FREEMAIL_FROM=0.001, RCVD_IN_DNSWL_NONE=-0.0001, SPF_PASS=-0.001] autolearn=ham autolearn_force=no
Authentication-Results: ietfa.amsl.com (amavisd-new); dkim=pass (2048-bit key) header.d=gmail.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 4UJ-elIcfzSZ for <yang-doctors@ietfa.amsl.com>; Mon, 5 Mar 2018 17:22:41 -0800 (PST)
Received: from mail-pg0-x232.google.com (mail-pg0-x232.google.com [IPv6:2607:f8b0:400e:c05::232]) (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 E10181276AF for <yang-doctors@ietf.org>; Mon, 5 Mar 2018 17:22:39 -0800 (PST)
Received: by mail-pg0-x232.google.com with SMTP id e3so2955779pga.6 for <yang-doctors@ietf.org>; Mon, 05 Mar 2018 17:22:39 -0800 (PST)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=mime-version:subject:from:in-reply-to:date:cc :content-transfer-encoding:message-id:references:to; bh=hzzpSTuUMdUB/ZVY2X4Z/87+XhAktxScXN9QSGh84XU=; b=XLUEwCIqqAn+2E1wDgP0+7N5VZDzosKB2ipgJ0+fvMF4Jkl8WvZ36/zhcIazsHr6ZT Pavk6hS20EYuEGDwjSieP5tbF8DLUxSgnu/tYcpJkDtOsOfriq4zTExZ0X9kQ6g5bbvW qdTLCqrRBgKqci3v63v6PWRKwIp0UlUkh1t0cjX7xsvTnNsW1mgNUfabwOXXxgmX1jtN QubdMrqT6UljlXZweNIA2Bn8Z/Jj+j6lF04jGnCTEG6Iku03aCB3+BGDq3kRIk+9LdUK biEehyZgzMICJ9OJIVviNqzbimf5eSF0dbzF+hcTQv7ppH6RCKMMiiO9Qbz3A43xwTWA 0HhA==
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:mime-version:subject:from:in-reply-to:date:cc :content-transfer-encoding:message-id:references:to; bh=hzzpSTuUMdUB/ZVY2X4Z/87+XhAktxScXN9QSGh84XU=; b=NRmN2zq3KlPPlDh2IRpNIpq/xWelfsAMGxYyjC5I7micT8WwbLH25un2o6YX/+YS5h D7uRQOPBNXFQAVj5sicYHyvkAmqRioKc8kErd+nnh1oNbOCvMTFvpUPsbaT8szGGbNwQ 6ktOBuLbHEcF1pSOeKZn83mpATEOue3j9sf89x+WzihY5HEuj/s/DG7no6f8vCAEnYuJ 6abQ4lq9TfjxxITLstSp4Y1Z7sWYLPp8yiiSYvodLJEOolfJtT8yK4lkS5EaB3VyJFX2 +zwC+KnjUc2hzFcNY7RQ3WWJWT8VBA433WvYGOYiczlmXDKVp29M5z/1ktFbQpp9xnip cITw==
X-Gm-Message-State: APf1xPDZ5mnuOEY9UOl378a+DKBRCa/phIkb56Uosgx1zM5PgFNJ1ftL r6kZnfOVgdV95RpPBMkOO+Y=
X-Google-Smtp-Source: AG47ELuqJMIH43VsQ5r+LZyukt9bYu5GU0aaY/QfrGuymqxVKbI2mZyU/HSUtrGYD7YaM4zxuFXZ8g==
X-Received: by 10.101.82.195 with SMTP id z3mr13870830pgp.308.1520299359299; Mon, 05 Mar 2018 17:22:39 -0800 (PST)
Received: from ?IPv6:2601:647:4700:1280:f854:a3e7:2bf9:f82f? ([2601:647:4700:1280:f854:a3e7:2bf9:f82f]) by smtp.gmail.com with ESMTPSA id m3sm21016990pgd.3.2018.03.05.17.22.38 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Mon, 05 Mar 2018 17:22:38 -0800 (PST)
Content-Type: text/plain; charset="us-ascii"
Mime-Version: 1.0 (Mac OS X Mail 11.2 \(3445.5.20\))
From: Mahesh Jethanandani <mjethanandani@gmail.com>
In-Reply-To: <20180305.143350.1574953054173250656.mbj@tail-f.com>
Date: Mon, 05 Mar 2018 17:22:48 -0800
Cc: lear@cisco.com, yang-doctors@ietf.org
Content-Transfer-Encoding: quoted-printable
Message-Id: <93D9F855-7F48-49A8-963E-2AFBBDFF8639@gmail.com>
References: <da08c294-ff92-9457-8b3b-ba0c0d0d83b6@cisco.com> <20180305.143350.1574953054173250656.mbj@tail-f.com>
To: Martin Bjorklund <mbj@tail-f.com>
X-Mailer: Apple Mail (2.3445.5.20)
Archived-At: <https://mailarchive.ietf.org/arch/msg/yang-doctors/6dtgGrQ0U5eHU6dXZtFKAJZ63k0>
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: Tue, 06 Mar 2018 01:22:43 -0000

I know that Lada has a git repository template to develop YANG models that for some reason I cannot find right now.

Similar to what Martin has mentioned below, I use make and scripts developed by Kent that allow me to develop YANG models and their examples separately from the draft. Doing that allows me to validate them before including them in the draft before publication. 

For an example look at the ACL model in the GitHub repository.

Cheers.

> On Mar 5, 2018, at 5:33 AM, Martin Bjorklund <mbj@tail-f.com> wrote:
> 
> 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
> 
> _______________________________________________
> yang-doctors mailing list
> yang-doctors@ietf.org
> https://www.ietf.org/mailman/listinfo/yang-doctors

Mahesh Jethanandani
mjethanandani@gmail.com