On Thu, Dec 29, 2022 at 7:20 AM Igor Zhukov <[email protected]> wrote: > > From: Igor Zhukov <[email protected]> > > Found at https://docs.ovn.org/en/latest/internals/maintainers.html > > Signed-off-by: Igor Zhukov <[email protected]> > > --- > MAINTAINERS.rst | 6 +++--- > 1 file changed, 3 insertions(+), 3 deletions(-) > > diff --git a/MAINTAINERS.rst b/MAINTAINERS.rst > index a4012a5cf..adb4ffca2 100644 > --- a/MAINTAINERS.rst > +++ b/MAINTAINERS.rst > @@ -29,10 +29,10 @@ OVN committers are the people who have been granted access to push > changes to to the OVN git repository. > > The responsibilities of an OVN committer are documented > -`here <Documentation/internals/committer-responsibilities.rst>`__. > +:doc:`committer-responsibilities`. > > The process for adding or removing committers is documented > -`here <Documentation/internals/committer-grant-revocation.rst>`__. > +:doc:`committer-grant-revocation`. > > This is the current list of active OVN committers: > > @@ -60,7 +60,7 @@ This is the current list of active OVN committers: > > The project also maintains a list of Emeritus Committers (or Maintainers). > More information about Emeritus Committers can be found > -`here <Documentation/internals/committer-emeritus-status.rst>`__. > +:doc:`committer-emeritus-status`. > > .. list-table:: OVS Emeritus Maintainers > :header-rows: 0 > -- > 2.34.1 > > _______________________________________________ > dev mailing list > [email protected] > https://mail.openvswitch.org/mailman/listinfo/ovs-dev
Hi Igor, Thanks for fixing. However, here is a dilemma. The :doc: extension doesn't work on github, so for root level documents it is not recommended to be used, as mentioned at: https://docs.ovn.org/en/latest/internals/contributing/documentation-style.html#restructuredtext-vs-sphinx The MAINTAINERS.rst is a root level document but it is included by the Documents/internals/maintainers.rst. The current format works well on github: https://github.com/ovn-org/ovn/blob/main/MAINTAINERS.rst So, I don't have a good solution to make both work. One idea is probably to include both types of links in the document, but it would make both versions look weird. Another idea may be, just remove the Documents/internals/maintainers.rst. What do you think? @Mark Michelson <[email protected]>@Numan Siddique <[email protected]>@Dumitru Ceara <[email protected]> Thanks, Han _______________________________________________ dev mailing list [email protected] https://mail.openvswitch.org/mailman/listinfo/ovs-dev
