[dev] Missing developer documentation
lberger at labn.net
Mon Dec 11 16:18:55 EST 2017
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) .
Does anyone care to comment on this? , i.e. are you (not) okay with
replacing the current md and texi formats with reST?
There is a PR starting this change...
PS I have no memory of the discussion (and may even have been there
with glazed over eyes) so was surprised by the PR
On 7/25/2017 9:35 AM, Olivier Dugeon wrote:
> 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, so I prefer to remove it as suggested during the PR review.
> For me, the main problem is how to start writing a such documentation ?
> First, it is too huge and to complicated to be written by only one person.
> 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.
> Finally, we need to organize themselves in order to collectively
> decided how to write them, to formalize the document through a common
> template, to harmonize the documentation...
> I would start by proposing:
> * start discussion about this new topic (create a new issue in
> github) during regular meeting
> * decide the document format (Markdown, in line github Wiki, LaTeX,
> TeXi ...)
> * create a new doc project within FRRouting
> * propose template
> * propose Table of Content for each document (perhaps partially common)
> * open contribution to the different documents
> Comments are welcome.
> dev mailing list
> dev at lists.frrouting.org
-------------- next part --------------
An HTML attachment was scrubbed...
More information about the dev