<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
</head>
<body text="#000000" bgcolor="#FFFFFF">
<p><font face="Ubuntu">Hi Quentin, Lou,</font></p>
<p><font face="Ubuntu"><font face="Ubuntu">I search in my note and
didn't find any reference to this decision nor any answer to
my original mail on the list. I just remem<font face="Ubuntu">ber
that we talk about the <font face="Ubuntu"><font
face="Ubuntu">developer</font> documentation during a
weekly meeting, but didn't rem<font face="Ubuntu">ember
about such decision. Perhaps David ha<font face="Ubuntu">s
a better memory.</font></font></font></font></font></font></p>
<p><font face="Ubuntu"><font face="Ubuntu"><font face="Ubuntu"><font
face="Ubuntu"><font face="Ubuntu"><font face="Ubuntu"><font
face="Ubuntu">Disregarding this point, I <font
face="Ubuntu">agree with Lou about documentation
format. We must keep only one. Up to now, we have
<font face="Ubuntu">4 differen<font face="Ubuntu">t
formats: txt, texi, md and rest. There is at
least 2 too many. I mean, texi is mandatory in
order to produce man pages and then we have to
choose between txt, md and rest. Txt is too
light and don't allow any emphasis. So, the
choice is between md and rest. <br>
</font></font></font></font></font></font></font></font></font></font></p>
<p><font face="Ubuntu"><font face="Ubuntu"><font face="Ubuntu"><font
face="Ubuntu"><font face="Ubuntu"><font face="Ubuntu"><font
face="Ubuntu"><font face="Ubuntu"><font
face="Ubuntu"><font face="Ubuntu"><font
face="Ubuntu">Just to help<font
face="Ubuntu"> in the decision, there is
converter between the <font face="Ubuntu">rest
and md <font face="Ubuntu">format that
allow<font face="Ubuntu"> us to not
loose previous efforts and
contributions</font>:</font></font></font></font></font></font></font></font></font></font></font></font></font></font></p>
<p><a href="https://github.com/chrissimpkins/md2rst">https://github.com/chrissimpkins/md2rst</a></p>
<p><a href="https://github.com/cgwrench/rst2md">https://github.com/cgwrench/rst2md</a></p>
Regards<br>
<br>
Olivier<br>
<br>
<div class="moz-cite-prefix">Le 11/12/2017 à 22:34, Quentin Young a
écrit :<br>
</div>
<blockquote type="cite"
cite="mid:E8A2EEC6-283A-43C7-BAC7-B8E806DD338B@cumulusnetworks.com">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
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=""
moz-do-not-send="true">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=""
moz-do-not-send="true">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=""
moz-do-not-send="true">lberger@labn.net</a>>
wrote:</div>
<br class="Apple-interchange-newline">
<div 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="">
<p class=""><font class="" face="Ubuntu">Hi<font
class="" face="Ubuntu"> 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 class="" face="Ubuntu">, so
I prefer to remove it as suggested during
the PR review.</font><br class="">
<br class="">
For me, <font class="" face="Ubuntu">t</font>he
main problem is how to start writing a such
documentation ?</font></p>
<p class=""><font class="" face="Ubuntu">First,
it is too huge and to complicated to be
written by only one person.</font></p>
<p class=""><font class="" 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 class=""><font class="" face="Ubuntu">Finally,
<font class="" face="Ubuntu">we need to
organize themselves in order to
collectively decided how to write them, <font
class="" face="Ubuntu">to </font></font>formalize
the document through a common template, to
harmonize the documentation<font class=""
face="Ubuntu"> ...</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
class="" face="Ubuntu">regular meeting</font><br
class="">
* <font class="" face="Ubuntu">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 class="" face="Ubuntu"><font
class="" face="Ubuntu">Comments are
welcome.</font></font></p>
<p class=""><font class="" face="Ubuntu"><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 class="" wrap="">_______________________________________________
dev mailing list
<a class="moz-txt-link-abbreviated" href="mailto:dev@lists.frrouting.org" moz-do-not-send="true">dev@lists.frrouting.org</a>
<a class="moz-txt-link-freetext" href="https://lists.frrouting.org/listinfo/dev" moz-do-not-send="true">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=""
moz-do-not-send="true">dev@lists.frrouting.org</a><br
class="">
<a class="moz-txt-link-freetext" href="https://lists.frrouting.org/listinfo/dev">https://lists.frrouting.org/listinfo/dev</a><br class="">
</div>
</blockquote>
</div>
<br class="">
</div>
</div>
</div>
</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>
<PRE>_________________________________________________________________________________________________________________________
Ce message et ses pieces jointes peuvent contenir des informations confidentielles ou privilegiees et ne doivent donc
pas etre diffuses, exploites ou copies sans autorisation. Si vous avez recu ce message par erreur, veuillez le signaler
a l'expediteur et le detruire ainsi que les pieces jointes. Les messages electroniques etant susceptibles d'alteration,
Orange decline toute responsabilite si ce message a ete altere, deforme ou falsifie. Merci.
This message and its attachments may contain confidential or privileged information that may be protected by law;
they should not be distributed, used or copied without authorisation.
If you have received this email in error, please notify the sender and delete this message and its attachments.
As emails may be altered, Orange is not liable for messages that have been modified, changed or falsified.
Thank you.
</PRE></body>
</html>