Re: [netmod] WG adoption poll draft-lhotka-netmod-yang-markup-00

Kent Watsen <kwatsen@juniper.net> writes:

> All,
>
> We're a couple days away from the 2-week window.  As of now, the
> majority does not support adopting this draft.  Any remaining
> opinions?
>
>
> Lada,
>
> The objections seem to be concern for net readability, and for the
> importance of the problem relative to other activities.  For the
> former case, it may help if you posted some examples.  For the

A typical lightweight markup language is markdown, and I believe most
people are familiar with it - if not, examples are easy to find.

The bare minimum of markdown features from which even existing modules
could benefit may be this:

- multiple paragraphs (separated by one or more blank lines) that can be
  re-flowed

- bulleted and numbered lists, possibly with multiple levels and
  multiple paragraphs per list item

- hyperlinks, such as [RFC 7950](https://tools.ietf.org/html/rfc7950)

and perhaps also

- *emphasis* and **strong emphasis**

- code blocks for showing example snippets where line breaks need to be retained.

> latter case, we may want to keep this draft cooking in the 
> background.

I am going to use the above conventions in my modules, and support them
in my tools. That's basically all what I need for the time being.

Lada

>
>
> Kent // as co-chair and potential shepherd
>
>
>
> Phil Shafer <phil@juniper.net> writes:
>
>> Andy Bierman writes:
>>>IMO it is more robust not to assume people never see the real YANG
>>>statements.
>>
>> Exactly.  We made YANG readable so that we wouldn't _need_ to view
>> it using tools.  This was one of the "insta-death" factors for UML.
>
> I have to reiterate that the idea is to continue to be able to view YANG
> modules *without* using tools, but provide some aid to tools that can make
> use of certain well-defined lightweight markup conventions.
>
> Everybody with a practical experience of converting YANG automatically
> to something else (not only to HTML, it starts already with YIN) knows
> that transferring descriptions and other similar texts is tricky.
>
> Lada
>
>>
>> Thanks,
>>  Phil
>>
>> _______________________________________________
>> netmod mailing list
>> netmod@ietf.org
>> https://www.ietf.org/mailman/listinfo/netmod
>
> -- 
> Ladislav Lhotka, CZ.NIC Labs
> PGP Key ID: 0xB8F92B08A9F76C67
>
> _______________________________________________
> netmod mailing list
> netmod@ietf.org
> https://www.ietf.org/mailman/listinfo/netmod
>
>

-- 
Ladislav Lhotka, CZ.NIC Labs
PGP Key ID: 0xB8F92B08A9F76C67