[ovs-discuss] Adding further man pages to man7.org : OVN

Flavio Fernandes flaviof at redhat.com
Mon May 3 14:59:39 UTC 2021


bump



On Wed, Apr 28, 2021 at 11:20 AM Flavio Fernandes <flaviof at redhat.com>
wrote:

> [cc Mark, OVN discuss]
>
> Hello Michael,
>
> I've recently done some work on automating the man pages for ovn.org [0]
> and would like to see if man7.org could be updated to pick up a more
> recent content of that. Based on the link from blog.man7.org [1], here is
> some info on OVN. Since that page was written in 2014, I wonder if that is
> still valid. Please let me know if I looked at the wrong place.
>
> OVN was split out of the Openvswitch repo in 2019 via [2], but we still
> share the same mailing lists. It is likely that the content related to OVN
> is in man7.org while it was part of OVS still. That said, OVS man pages
> may also need an update, right?
>
> * Name of the project.
>
> Open Virtual Network
>
> * Project description.
>
> OVN (Open Virtual Network) is a series of daemons for the Open vSwitch
> that translate virtual network configurations into OpenFlow.
>
> * URL for the web site the project.
>
> https://www.ovn.org/en/
>
> (If you know it:) URL of a web page that provides information on how to
> report bugs in the man pages (or email list address).
>
> https://www.ovn.org/en/contributing/
>
> * Source URL for the man pages of the project. The project should provide
> pages by one of the following means one of the following:
>
> Ideally: the URL of a Git repository for the project.
>
> https://github.com/ovn-org/ovn
> Info on releases is available here:
> https://www.ovn.org/en/releases/
>
> * Instructions on how to build the man pages for the project. These
> instructions should be minimal, in the sense that they require the minimum
> CPU effort to build just the man pages. In other words, if possible, I'd
> like to avoid building the entire project just to obtain the manual pages.
>
> To build the man pages, follow (or run) the github workflow [3].
> As you can see in [0]. The built docs are stored under
>
> https://github.com/ovn-org/ovn-website/tree/master/src/static/support/
>
> https://www.ovn.org/support/dist-docs/  <-- latest, master branch
> src/static/support/dist-docs-branch-21.03/  <-- branch-21.03
>
> * Approximate number of manual pages in the project (actual pages,
> excluding links).
>
> ~/work/ovn-website.git/src/static/support/dist-docs
> $ find . -name "*.html" | wc -l
>       18
>
> Thanks,
>
> -- flaviof
>
> [0]:
> https://github.com/ovn-org/ovn-website/commit/84a6d0556f9325c5a613b4e47bb3da1fd1240a2e
>
> [1]:http://blog.man7.org/2013/05/adding-further-man-pages-to-html.html
>
> [2]:
> https://github.com/openvswitch/ovs/commit/f3e24610ea18eb873dc860f1710432e9aacd27fd
>
> [3]:
> https://github.com/ovn-org/ovn-website/blob/master/.github/workflows/dist-docs.yml
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.openvswitch.org/pipermail/ovs-discuss/attachments/20210503/f8dd87e5/attachment.html>


More information about the discuss mailing list