<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"></head><body style="word-wrap: break-word; -webkit-nbsp-mode: space; line-break: after-white-space;" class="">Just to add some background here—<div class=""><br class=""></div><div class="">My recollection is that we held the meeting Lou mentioned between the date of Olivier’s email (July 25) and August 8th. On August 8th, we merged the following pull request from David Lamparter:</div><div class=""><br class=""><div class=""><a href="https://github.com/FRRouting/frr/pull/929" class="">https://github.com/FRRouting/frr/pull/929</a></div><div class=""><br class=""></div><div class="">Note my comment on this PR (#929) where I state my opinion on the need to make a decision on the docs format before merging RST. The comment was later edited (with the edited part marked) to state we had agreed on RST; as I recall, I did this because we agreed on RST in a meeting.<br class=""><div class=""><br class=""></div><div class="">The current PR Lou referenced is this one:</div><div class=""><br class=""></div><div class=""><a href="https://github.com/FRRouting/frr/pull/1530" class="">https://github.com/FRRouting/frr/pull/1530</a></div><div class=""><br class=""></div><div class="">In light of #929, referring to #1530 as “starting this change” may be a slight mischaracterization. My 2c.</div><div class=""><br class=""></div><div class="">Quentin</div><div class=""><div class=""><div><br class=""><blockquote type="cite" class=""><div class="">On Dec 11, 2017, at 4:18 PM, Lou Berger <<a href="mailto:lberger@labn.net" class="">lberger@labn.net</a>> wrote:</div><br class="Apple-interchange-newline"><div class="">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" class="">
<div text="#000000" bgcolor="#FFFFFF" class=""><p class="">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 class="">Does anyone care to comment on this? , i.e. are you (not) okay
with replacing the current md and texi formats with reST? <br class="">
</p><p class="">There is a PR starting this change...</p><p class="">Thanks,</p><p class="">Lou<br class="">
</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 class="">
<br class="">
<div class="moz-cite-prefix">On 7/25/2017 9:35 AM, Olivier Dugeon
wrote:<br class="">
</div>
<blockquote type="cite" cite="mid:e9891041-6b48-a384-cfad-5feff0e4c62f@orange.com" class="">
<meta http-equiv="content-type" content="text/html; charset=utf-8" class=""><p class=""><font face="Ubuntu" class="">Hi<font face="Ubuntu" class=""> all,</font><br class="">
<br class="">
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" class="">, so I prefer to
remove it as suggested during the PR review.</font><br class="">
<br class="">
For me, <font face="Ubuntu" class="">t</font>he main problem is how to
start writing a such documentation ?</font></p><p class=""><font face="Ubuntu" class="">First, it is too huge and to complicated to
be written by only one person.</font></p><p class=""><font face="Ubuntu" class="">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 class=""><font face="Ubuntu" class="">Finally, <font face="Ubuntu" class="">we need to
organize themselves in order to collectively decided how to
write them, <font face="Ubuntu" class="">to </font></font>formalize
the document through a common template, to harmonize the
documentation<font face="Ubuntu" class=""> ...</font><br class="">
<br class="">
I would start by proposing:<br class="">
* start discussion about this new topic (create a new issue
in github) during <font face="Ubuntu" class="">regular meeting</font><br class="">
* <font face="Ubuntu" class="">decide</font> the document format
(Markdown, in line github Wiki, LaTeX, TeXi ...)<br class="">
* create a new doc project within FRRouting<br class="">
* propose template<br class="">
* propose Table of Content for each document (perhaps
partially common)<br class="">
* open contribution to the different documents</font></p><p class=""><font face="Ubuntu" class=""><font face="Ubuntu" class="">Comments are welcome.</font></font></p><p class=""><font face="Ubuntu" class=""><br class="">
Regards<br class="">
<br class="">
Olivier</font><br class="">
</p>
<div class="moz-signature"><br class="">
<span style="margin:0px 0 20px 0;" class=""> </span> </div>
<br class="">
<fieldset class="mimeAttachmentHeader"></fieldset>
<br class="">
<pre wrap="" class="">_______________________________________________
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 class="">
</div>
_______________________________________________<br class="">dev mailing list<br class=""><a href="mailto:dev@lists.frrouting.org" class="">dev@lists.frrouting.org</a><br class="">https://lists.frrouting.org/listinfo/dev<br class=""></div></blockquote></div><br class=""></div></div></div></div></body></html>