[ovs-dev] [PATCH ovn] Documentation: Change 'Open vSwitch' for 'OVN' and logo

Ilya Maximets i.maximets at ovn.org
Tue Mar 17 16:10:58 UTC 2020


On 3/17/20 4:17 PM, Daniel Alvarez wrote:
> The current version of the documentation is still using the
> Open vSwitch logo and includes some references to OVS that
> should be changed by OVN.
> 
> Signed-off-by: Daniel Alvarez <dalvarez at redhat.com>
> ---
> 
> diff --git a/Documentation/automake.mk b/Documentation/automake.mk
> index 2f337532c..ca1fb1222 100644
> --- a/Documentation/automake.mk
> +++ b/Documentation/automake.mk
> @@ -1,7 +1,6 @@
>  DOC_SOURCE = \
>  	Documentation/group-selection-method-property.txt \
>  	Documentation/_static/logo.png \
> -	Documentation/_static/overview.png \
>  	Documentation/conf.py \
>  	Documentation/index.rst \
>  	Documentation/contents.rst \
> diff --git a/Documentation/conf.py b/Documentation/conf.py
> index 2c85dcf4d..c7949b73e 100644
> --- a/Documentation/conf.py
> +++ b/Documentation/conf.py
> @@ -47,9 +47,9 @@ source_suffix = '.rst'
>  master_doc = 'contents'
> 
>  # General information about the project.
> -project = u'Open vSwitch'
> -copyright = u'2016, The Open vSwitch Development Community'
> -author = u'The Open vSwitch Development Community'
> +project = u'OVN'
> +copyright = u'2020, The OVN Development Community'
> +author = u'The OVN Development Community'
> 
>  # The version info for the project you're documenting, acts as replacement for
>  # |version| and |release|, also used in various other places throughout the
> diff --git a/Documentation/contents.rst b/Documentation/contents.rst
> index a754bd225..469dfc34d 100644
> --- a/Documentation/contents.rst
> +++ b/Documentation/contents.rst
> @@ -22,7 +22,7 @@
>        Avoid deeper levels because they do not render well.
> 
>  ===================================
> -Open vSwitch Documentation Contents
> +OVN Documentation Contents
>  ===================================

Upper/underlines should match the text length, i.e.

=======
My text
=======

Longer test
-----------

rST format requires that and there will be a warning.


Same for all ther changes here.

> 
>  .. toctree::
> diff --git a/Documentation/faq/index.rst b/Documentation/faq/index.rst
> index 7ad71aabe..f2b3afba8 100644
> --- a/Documentation/faq/index.rst
> +++ b/Documentation/faq/index.rst
> @@ -24,7 +24,7 @@
>        Avoid deeper levels because they do not render well.
> 
>  ================
> -Open vSwitch FAQ
> +OVN FAQ
>  ================
> 
>  .. toctree::
> diff --git a/Documentation/index.rst b/Documentation/index.rst
> index c0c6c374d..b026fe4fd 100644
> --- a/Documentation/index.rst
> +++ b/Documentation/index.rst
> @@ -24,13 +24,13 @@
>        Avoid deeper levels because they do not render well.
> 
>  ==========================
> -Open vSwitch Documentation
> +OVN Documentation
>  ==========================
> 
>  How the Documentation is Organised
>  ----------------------------------
> 
> -The Open vSwitch documentation is organised into multiple sections:
> +The OVN documentation is organised into multiple sections:
> 
>  - :doc:`Installation guides </intro/install/index>` guide you through
>    installing Open vSwitch (OVS) and Open Virtual Network (OVN) on a variety of
> @@ -68,10 +68,10 @@ Deeper Dive
>    :doc:`intro/install/rhel` |
>    :doc:`intro/install/fedora`
> 
> -The Open vSwitch Project
> +The OVN Project
>  ------------------------
> 
> -Learn more about the Open vSwitch project and about how you can contribute:
> +Learn more about the OVN project and about how you can contribute:
> 
>  - **Community:** :doc:`internals/release-process` |
>    :doc:`internals/authors` |
> @@ -90,7 +90,7 @@ Learn more about the Open vSwitch project and about how you can contribute:
>    :doc:`internals/committer-emeritus-status`
> 
>  - **Documentation:** :doc:`internals/contributing/documentation-style` |
> -  :doc:`Building Open vSwitch Documentation <intro/install/documentation>` |
> +  :doc:`Building OVN Documentation <intro/install/documentation>` |
>    :doc:`internals/documentation`
> 
>  Getting Help
> --
> 
> _______________________________________________
> dev mailing list
> dev at openvswitch.org
> https://mail.openvswitch.org/mailman/listinfo/ovs-dev
> 



More information about the dev mailing list