diff mbox series

[ovs-dev,3/5] Documentation: Use links to OVN documentation when applicable.

Message ID 20240321161001.644616-4-dceara@redhat.com
State Changes Requested
Headers show
Series Various treewide fixes. | expand

Checks

Context Check Description
ovsrobot/apply-robot success apply and check: success
ovsrobot/github-robot-_Build_and_Test success github build: passed
ovsrobot/github-robot-_ovn-kubernetes success github build: passed

Commit Message

Dumitru Ceara March 21, 2024, 4:09 p.m. UTC
Some of the links were still pointing to OVS although we have
OVN counterparts.

Signed-off-by: Dumitru Ceara <dceara@redhat.com>
---
 Documentation/intro/install/fedora.rst | 2 +-
 Documentation/intro/install/rhel.rst   | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

Comments

Ilya Maximets March 21, 2024, 5:34 p.m. UTC | #1
On 3/21/24 17:09, Dumitru Ceara wrote:
> Some of the links were still pointing to OVS although we have
> OVN counterparts.
> 
> Signed-off-by: Dumitru Ceara <dceara@redhat.com>
> ---
>  Documentation/intro/install/fedora.rst | 2 +-
>  Documentation/intro/install/rhel.rst   | 2 +-
>  2 files changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/Documentation/intro/install/fedora.rst b/Documentation/intro/install/fedora.rst
> index 5b2a37cffd..d18e72ba6b 100644
> --- a/Documentation/intro/install/fedora.rst
> +++ b/Documentation/intro/install/fedora.rst
> @@ -132,7 +132,7 @@ installation requires superuser privileges.
>  Refer to the `RHEL README`__ for additional usage and configuration
>  information.
>  
> -__ https://github.com/openvswitch/ovs/blob/master/rhel/README.RHEL.rst
> +__ https://github.com/ovn-org/ovn/blob/main/rhel/README.RHEL.rst
>  
>  Reporting Bugs
>  --------------
> diff --git a/Documentation/intro/install/rhel.rst b/Documentation/intro/install/rhel.rst
> index d68709a704..c187300f80 100644
> --- a/Documentation/intro/install/rhel.rst
> +++ b/Documentation/intro/install/rhel.rst
> @@ -229,7 +229,7 @@ implemented.  Refer to `README.RHEL.rst`__ in the source tree or
>  /usr/share/doc/openvswitch/README.RHEL.rst in the installed openvswitch package
>  for details.
>  
> -__ https://github.com/openvswitch/ovs/blob/master/rhel/README.RHEL.rst
> +__ https://github.com/ovn-org/ovn/blob/main/rhel/README.RHEL.rst

This whole document is describing OVS RHEL packaging and has nothing
to do with OVN.  I'm not sure why OVN link should be here. :)

The whole document should be re-written.

The rhel/README.RHEL.rst also only describes OVS' integration with
network scripts and systems.  Has nothing to do with OVN.

Best regards, Ilya Maximets.
Dumitru Ceara March 21, 2024, 5:41 p.m. UTC | #2
On 3/21/24 18:34, Ilya Maximets wrote:
> On 3/21/24 17:09, Dumitru Ceara wrote:
>> Some of the links were still pointing to OVS although we have
>> OVN counterparts.
>>
>> Signed-off-by: Dumitru Ceara <dceara@redhat.com>
>> ---
>>  Documentation/intro/install/fedora.rst | 2 +-
>>  Documentation/intro/install/rhel.rst   | 2 +-
>>  2 files changed, 2 insertions(+), 2 deletions(-)
>>
>> diff --git a/Documentation/intro/install/fedora.rst b/Documentation/intro/install/fedora.rst
>> index 5b2a37cffd..d18e72ba6b 100644
>> --- a/Documentation/intro/install/fedora.rst
>> +++ b/Documentation/intro/install/fedora.rst
>> @@ -132,7 +132,7 @@ installation requires superuser privileges.
>>  Refer to the `RHEL README`__ for additional usage and configuration
>>  information.
>>  
>> -__ https://github.com/openvswitch/ovs/blob/master/rhel/README.RHEL.rst
>> +__ https://github.com/ovn-org/ovn/blob/main/rhel/README.RHEL.rst
>>  
>>  Reporting Bugs
>>  --------------
>> diff --git a/Documentation/intro/install/rhel.rst b/Documentation/intro/install/rhel.rst
>> index d68709a704..c187300f80 100644
>> --- a/Documentation/intro/install/rhel.rst
>> +++ b/Documentation/intro/install/rhel.rst
>> @@ -229,7 +229,7 @@ implemented.  Refer to `README.RHEL.rst`__ in the source tree or
>>  /usr/share/doc/openvswitch/README.RHEL.rst in the installed openvswitch package
>>  for details.
>>  
>> -__ https://github.com/openvswitch/ovs/blob/master/rhel/README.RHEL.rst
>> +__ https://github.com/ovn-org/ovn/blob/main/rhel/README.RHEL.rst
> 
> This whole document is describing OVS RHEL packaging and has nothing
> to do with OVN.  I'm not sure why OVN link should be here. :)
> 
> The whole document should be re-written.
> 
> The rhel/README.RHEL.rst also only describes OVS' integration with
> network scripts and systems.  Has nothing to do with OVN.
> 

I'll fix them both up in v2.  I was hoping for an easy patch, I guess I
was too optimistic. :)

> Best regards, Ilya Maximets.
> 

Regards,
Dumitru
diff mbox series

Patch

diff --git a/Documentation/intro/install/fedora.rst b/Documentation/intro/install/fedora.rst
index 5b2a37cffd..d18e72ba6b 100644
--- a/Documentation/intro/install/fedora.rst
+++ b/Documentation/intro/install/fedora.rst
@@ -132,7 +132,7 @@  installation requires superuser privileges.
 Refer to the `RHEL README`__ for additional usage and configuration
 information.
 
-__ https://github.com/openvswitch/ovs/blob/master/rhel/README.RHEL.rst
+__ https://github.com/ovn-org/ovn/blob/main/rhel/README.RHEL.rst
 
 Reporting Bugs
 --------------
diff --git a/Documentation/intro/install/rhel.rst b/Documentation/intro/install/rhel.rst
index d68709a704..c187300f80 100644
--- a/Documentation/intro/install/rhel.rst
+++ b/Documentation/intro/install/rhel.rst
@@ -229,7 +229,7 @@  implemented.  Refer to `README.RHEL.rst`__ in the source tree or
 /usr/share/doc/openvswitch/README.RHEL.rst in the installed openvswitch package
 for details.
 
-__ https://github.com/openvswitch/ovs/blob/master/rhel/README.RHEL.rst
+__ https://github.com/ovn-org/ovn/blob/main/rhel/README.RHEL.rst
 
 Reporting Bugs
 --------------