<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
</head>
<body text="#000000" bgcolor="#FFFFFF">
<p>so it seems there was some discussion on this in August where the
agreement among those who participated in that weekly call was to
move to reStructuredText (reST) .</p>
<p>Does anyone care to comment on this? , i.e. are you (not) okay
with replacing the current md and texi formats with reST? <br>
</p>
<p>There is a PR starting this change...</p>
<p>Thanks,</p>
<p>Lou<br>
</p>
PS I have no memory of the discussion (and may even have been there
with glazed over eyes) so was surprised by the PR<br>
<br>
<div class="moz-cite-prefix">On 7/25/2017 9:35 AM, Olivier Dugeon
wrote:<br>
</div>
<blockquote type="cite"
cite="mid:e9891041-6b48-a384-cfad-5feff0e4c62f@orange.com">
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<p><font face="Ubuntu">Hi<font face="Ubuntu"> all,</font><br>
<br>
There is missing developer documentation in FRR. In PR #805 I
try to update an old Zebra hacking document, but that seems
too old to be publish<font face="Ubuntu">, so I prefer to
remove it as suggested during the PR review.</font><br>
<br>
For me, <font face="Ubuntu">t</font>he main problem is how to
start writing a such documentation ?</font></p>
<p><font face="Ubuntu">First, it is too huge and to complicated to
be written by only one person.</font></p>
<p><font face="Ubuntu">Second, we need a dedicated space (e.g. a
new doc project inside FRRouting) to collectively write such
documentation and then push into frr master documents when
they are ready.</font></p>
<p><font face="Ubuntu">Finally, <font face="Ubuntu">we need to
organize themselves in order to collectively decided how to
write them, <font face="Ubuntu">to </font></font>formalize
the document through a common template, to harmonize the
documentation<font face="Ubuntu"> ...</font><br>
<br>
I would start by proposing:<br>
* start discussion about this new topic (create a new issue
in github) during <font face="Ubuntu">regular meeting</font><br>
* <font face="Ubuntu">decide</font> the document format
(Markdown, in line github Wiki, LaTeX, TeXi ...)<br>
* create a new doc project within FRRouting<br>
* propose template<br>
* propose Table of Content for each document (perhaps
partially common)<br>
* open contribution to the different documents</font></p>
<p><font face="Ubuntu"><font face="Ubuntu">Comments are welcome.</font></font></p>
<p><font face="Ubuntu"><br>
Regards<br>
<br>
Olivier</font><br>
</p>
<div class="moz-signature"><br>
<span style="margin:0px 0 20px 0;"> </span> </div>
<br>
<fieldset class="mimeAttachmentHeader"></fieldset>
<br>
<pre wrap="">_______________________________________________
dev mailing list
<a class="moz-txt-link-abbreviated" href="mailto:dev@lists.frrouting.org">dev@lists.frrouting.org</a>
<a class="moz-txt-link-freetext" href="https://lists.frrouting.org/listinfo/dev">https://lists.frrouting.org/listinfo/dev</a>
</pre>
</blockquote>
<br>
</body>
</html>