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

[Roi Dayan]

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 
---
 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 `__.
+:doc:`here `.


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 `__.
+:doc:`here `.


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
d...@openvswitch.org
https://mail.openvswitch.org/mailman/listinfo/ovs-dev


___
dev mailing list
d...@openvswitch.org
https://mail.openvswitch.org/mailman/listinfo/ovs-dev

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

[Stephen Finucane]

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 
> ---
>  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 `__.
> +:doc:`here `.

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 `__.
> +:doc:`here `.

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
d...@openvswitch.org
https://mail.openvswitch.org/mailman/listinfo/ovs-dev

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

[Roi Dayan]

The links were pointing to static non-existent location instead
of internal doc link.

Signed-off-by: Roi Dayan 
---
 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 `__.
+:doc:`here `.
 
 The process for adding or removing committers is documented
-`here `__.
+:doc:`here `.
 
 This is the current list of Open vSwitch committers:
 
-- 
2.7.4

___
dev mailing list
d...@openvswitch.org
https://mail.openvswitch.org/mailman/listinfo/ovs-dev