[ovs-dev,ovs] Documentation: fix broken links in maintainers page

Submitted by Roi Dayan on April 18, 2017, 12:08 p.m.

Details

Message ID 1492517287-57436-1-git-send-email-roid@mellanox.com
State Superseded
Headers show

Commit Message

Roi Dayan April 18, 2017, 12:08 p.m.
The links were pointing to static non-existent location instead
of internal doc link.

Signed-off-by: Roi Dayan <roid@mellanox.com>
---
 MAINTAINERS.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Comments

Stephen Finucane April 18, 2017, 4:26 p.m.
On Tue, 2017-04-18 at 15:08 +0300, Roi Dayan wrote:
> The links were pointing to static non-existent location instead
> of internal doc link.
> 
> Signed-off-by: Roi Dayan <roid@mellanox.com>
> ---
>  MAINTAINERS.rst | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/MAINTAINERS.rst b/MAINTAINERS.rst
> index 28831ab..36c8d58 100644
> --- a/MAINTAINERS.rst
> +++ b/MAINTAINERS.rst
> @@ -29,10 +29,10 @@ Open vSwitch committers are the people who have
> been granted access to push
>  changes to to the Open vSwitch git repository.
>  
>  The responsibilities of an Open vSwitch committer are documented
> -`here <Documentation/committer-responsibilities.rst>`__.
> +:doc:`here <committer-responsibilities>`.

I don't think we can do this: these files are in the top-level and as
such are liable to be rendered on GitHub, which doesn't support Sphinx
directives like this. This is mentioned in the documentation guide [1].

We can do this, but be aware it will render funnily on GitHub.
Personally, I think updating the link would be easier.

>  The process for adding or removing committers is documented
> -`here <Documentation/committer-grant-revocation.rst>`__.
> +:doc:`here <committer-grant-revocation>`.

Ditto.

>  This is the current list of Open vSwitch committers:

Cheers,
Stephen

[1] http://docs.openvswitch.org/en/latest/internals/contributing/docume
ntation-style/
Roi Dayan April 19, 2017, 1:34 p.m.
On 18/04/2017 19:26, Stephen Finucane wrote:
> On Tue, 2017-04-18 at 15:08 +0300, Roi Dayan wrote:
>> The links were pointing to static non-existent location instead
>> of internal doc link.
>>
>> Signed-off-by: Roi Dayan <roid@mellanox.com>
>> ---
>>  MAINTAINERS.rst | 4 ++--
>>  1 file changed, 2 insertions(+), 2 deletions(-)
>>
>> diff --git a/MAINTAINERS.rst b/MAINTAINERS.rst
>> index 28831ab..36c8d58 100644
>> --- a/MAINTAINERS.rst
>> +++ b/MAINTAINERS.rst
>> @@ -29,10 +29,10 @@ Open vSwitch committers are the people who have
>> been granted access to push
>>  changes to to the Open vSwitch git repository.
>>
>>  The responsibilities of an Open vSwitch committer are documented
>> -`here <Documentation/committer-responsibilities.rst>`__.
>> +:doc:`here <committer-responsibilities>`.
>
> I don't think we can do this: these files are in the top-level and as
> such are liable to be rendered on GitHub, which doesn't support Sphinx
> directives like this. This is mentioned in the documentation guide [1].
>
> We can do this, but be aware it will render funnily on GitHub.
> Personally, I think updating the link would be easier.

right. thanks for the pointer.
I'll update the commit to fix the broken links but keep the style.

>
>>  The process for adding or removing committers is documented
>> -`here <Documentation/committer-grant-revocation.rst>`__.
>> +:doc:`here <committer-grant-revocation>`.
>
> Ditto.
>
>>  This is the current list of Open vSwitch committers:
>
> Cheers,
> Stephen
>
> [1] http://docs.openvswitch.org/en/latest/internals/contributing/docume
> ntation-style/
> _______________________________________________
> dev mailing list
> dev@openvswitch.org
> https://mail.openvswitch.org/mailman/listinfo/ovs-dev
>

Patch hide | download patch | download mbox

diff --git a/MAINTAINERS.rst b/MAINTAINERS.rst
index 28831ab..36c8d58 100644
--- a/MAINTAINERS.rst
+++ b/MAINTAINERS.rst
@@ -29,10 +29,10 @@  Open vSwitch committers are the people who have been granted access to push
 changes to to the Open vSwitch git repository.
 
 The responsibilities of an Open vSwitch committer are documented
-`here <Documentation/committer-responsibilities.rst>`__.
+:doc:`here <committer-responsibilities>`.
 
 The process for adding or removing committers is documented
-`here <Documentation/committer-grant-revocation.rst>`__.
+:doc:`here <committer-grant-revocation>`.
 
 This is the current list of Open vSwitch committers: