From patchwork Fri May 8 06:59:16 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Numan Siddique X-Patchwork-Id: 1285884 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Authentication-Results: ozlabs.org; spf=pass (sender SPF authorized) smtp.mailfrom=openvswitch.org (client-ip=140.211.166.138; helo=whitealder.osuosl.org; envelope-from=ovs-dev-bounces@openvswitch.org; receiver=) Authentication-Results: ozlabs.org; dmarc=none (p=none dis=none) header.from=ovn.org Received: from whitealder.osuosl.org (smtp1.osuosl.org [140.211.166.138]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ozlabs.org (Postfix) with ESMTPS id 49JLmc23BFz9sRf for ; Fri, 8 May 2020 16:59:43 +1000 (AEST) Received: from localhost (localhost [127.0.0.1]) by whitealder.osuosl.org (Postfix) with ESMTP id BBDFB883DD; Fri, 8 May 2020 06:59:41 +0000 (UTC) X-Virus-Scanned: amavisd-new at osuosl.org Received: from whitealder.osuosl.org ([127.0.0.1]) by localhost (.osuosl.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id 0DkhcZULGCu2; Fri, 8 May 2020 06:59:38 +0000 (UTC) Received: from lists.linuxfoundation.org (lf-lists.osuosl.org [140.211.9.56]) by whitealder.osuosl.org (Postfix) with ESMTP id 9F46287ED5; Fri, 8 May 2020 06:59:38 +0000 (UTC) Received: from lf-lists.osuosl.org (localhost [127.0.0.1]) by lists.linuxfoundation.org (Postfix) with ESMTP id 8DEFAC0889; Fri, 8 May 2020 06:59:38 +0000 (UTC) X-Original-To: dev@openvswitch.org Delivered-To: ovs-dev@lists.linuxfoundation.org Received: from silver.osuosl.org (smtp3.osuosl.org [140.211.166.136]) by lists.linuxfoundation.org (Postfix) with ESMTP id 34FFBC07FF for ; Fri, 8 May 2020 06:59:37 +0000 (UTC) Received: from localhost (localhost [127.0.0.1]) by silver.osuosl.org (Postfix) with ESMTP id 17F1E21537 for ; Fri, 8 May 2020 06:59:37 +0000 (UTC) X-Virus-Scanned: amavisd-new at osuosl.org Received: from silver.osuosl.org ([127.0.0.1]) by localhost (.osuosl.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id dBpVQEcFAtUO for ; Fri, 8 May 2020 06:59:32 +0000 (UTC) X-Greylist: domain auto-whitelisted by SQLgrey-1.7.6 Received: from relay8-d.mail.gandi.net (relay8-d.mail.gandi.net [217.70.183.201]) by silver.osuosl.org (Postfix) with ESMTPS id 4F21620116 for ; Fri, 8 May 2020 06:59:32 +0000 (UTC) X-Originating-IP: 115.99.89.246 Received: from nusiddiq.home.org.com (unknown [115.99.89.246]) (Authenticated sender: numans@ovn.org) by relay8-d.mail.gandi.net (Postfix) with ESMTPSA id 2E1111BF207; Fri, 8 May 2020 06:59:28 +0000 (UTC) From: numans@ovn.org To: dev@openvswitch.org Date: Fri, 8 May 2020 12:29:16 +0530 Message-Id: <20200508065916.618971-1-numans@ovn.org> X-Mailer: git-send-email 2.26.2 MIME-Version: 1.0 Cc: Dan Williams Subject: [ovs-dev] [PATCH ovn] docs: update various OVS references to OVN X-BeenThere: ovs-dev@openvswitch.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: ovs-dev-bounces@openvswitch.org Sender: "dev" From: Dan Williams Submitted-at: https://github.com/ovn-org/ovn/pull/40 Signed-off-by: Dan Williams Signed-off-by: Numan Siddique --- CONTRIBUTING.rst | 8 ++++---- Documentation/conf.py | 10 +++++----- Documentation/contents.rst | 6 +++--- Documentation/faq/index.rst | 6 +++--- Documentation/howto/docker.rst | 4 ++-- Documentation/index.rst | 14 +++++++------- Documentation/internals/documentation.rst | 13 ++++++------- Documentation/intro/index.rst | 2 +- Documentation/intro/install/distributions.rst | 6 +++--- Documentation/intro/install/documentation.rst | 14 +++++++------- Documentation/intro/install/index.rst | 12 ++++++------ Documentation/topics/index.rst | 6 +++--- ovn-architecture.7.xml | 2 +- rhel/ovn-fedora.spec.in | 2 +- 14 files changed, 52 insertions(+), 53 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 031c881d9..faf19d6f8 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -21,9 +21,9 @@ Avoid deeper levels because they do not render well. -============================ -Contributing to Open vSwitch -============================ +========================================== +Contributing to Open Virtual Network (OVN) +========================================== As an open source project, we welcome contributions of any kind. These can range from bug reports and code reviews, to signficant code or documentation @@ -31,4 +31,4 @@ features. Extensive guidelines are provided in the docs at ``Documentation/internals/contributing``, or `online -`__. +`__. diff --git a/Documentation/conf.py b/Documentation/conf.py index f072a4879..138ac8875 100644 --- a/Documentation/conf.py +++ b/Documentation/conf.py @@ -1,6 +1,6 @@ # -*- coding: utf-8 -*- # -# Open vSwitch documentation build configuration file, created by +# Open Virtual Network (OVN) documentation build configuration file, created by # sphinx-quickstart on Fri Sep 30 09:57:36 2016. # # This file is execfile()d with the current directory set to its @@ -47,9 +47,9 @@ source_suffix = '.rst' master_doc = 'contents' # General information about the project. -project = u'OVN' -copyright = u'2020, The OVN Development Community' -author = u'The OVN Development Community' +project = u'Open Virtual Network (OVN)' +copyright = u'2020, The Open Virtual Network (OVN) Development Community' +author = u'The Open Virtual Network (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 @@ -65,7 +65,7 @@ with open(filename, 'rU') as f: release = line.split(',')[1].strip(string.whitespace + '[]') break if release is None: - sys.stderr.write('%s: failed to determine Open vSwitch version\n' + sys.stderr.write('%s: failed to determine Open Virtual Network (OVN) version\n' % filename) sys.exit(1) diff --git a/Documentation/contents.rst b/Documentation/contents.rst index 836374806..1a7c05f22 100644 --- a/Documentation/contents.rst +++ b/Documentation/contents.rst @@ -21,9 +21,9 @@ Avoid deeper levels because they do not render well. -========================== -OVN Documentation Contents -========================== +================================================= +Open Virtual Network (OVN) Documentation Contents +================================================= .. toctree:: :maxdepth: 3 diff --git a/Documentation/faq/index.rst b/Documentation/faq/index.rst index d71cf5794..7ee4fd2fc 100644 --- a/Documentation/faq/index.rst +++ b/Documentation/faq/index.rst @@ -23,9 +23,9 @@ Avoid deeper levels because they do not render well. -======= -OVN FAQ -======= +============================== +Open Virtual Network (OVN) FAQ +============================== .. toctree:: :maxdepth: 2 diff --git a/Documentation/howto/docker.rst b/Documentation/howto/docker.rst index 906148679..f47fa7850 100644 --- a/Documentation/howto/docker.rst +++ b/Documentation/howto/docker.rst @@ -88,7 +88,7 @@ The "overlay" mode stored in the OVN\_Northbound database to logical flows in ``OVN_Southbound`` database. For example:: - $ /usr/share/openvswitch/scripts/ovn-ctl start_northd + $ /usr/share/ovn/scripts/ovn-ctl start_northd With Open vSwitch version of 2.7 or greater, you need to run the following additional commands (Please read the manpages of ovn-nb for more control @@ -142,7 +142,7 @@ The "overlay" mode You need to run the below command on every boot:: - $ /usr/share/openvswitch/scripts/ovn-ctl start_controller + $ /usr/share/ovn/scripts/ovn-ctl start_controller 4. Start the Open vSwitch network driver. diff --git a/Documentation/index.rst b/Documentation/index.rst index da396f357..730595c05 100644 --- a/Documentation/index.rst +++ b/Documentation/index.rst @@ -23,14 +23,14 @@ Avoid deeper levels because they do not render well. -================= -OVN Documentation -================= +======================================== +Open Virtual Network (OVN) Documentation +======================================== How the Documentation is Organised ---------------------------------- -The OVN documentation is organised into multiple sections: +The Open Virtual Network (OVN) documentation is organised into multiple sections: - :doc:`Installation guides ` 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 OVN Project ---------------- +The Open Virtual Network (OVN) Project +-------------------------------------- -Learn more about the OVN project and about how you can contribute: +Learn more about the Open Virtual Network (OVN) project and about how you can contribute: - **Community:** :doc:`internals/release-process` | :doc:`internals/authors` | diff --git a/Documentation/internals/documentation.rst b/Documentation/internals/documentation.rst index f7077acb9..72a120bef 100644 --- a/Documentation/internals/documentation.rst +++ b/Documentation/internals/documentation.rst @@ -57,22 +57,21 @@ Read the Docs ------------- The documentation is hosted on readthedocs.org and a CNAME redirect is in place -to allow access from docs.openvswitch.org. *Read the Docs* provides a couple of +to allow access from docs.ovn.org. *Read the Docs* provides a couple of nifty features for us, such as automatic building of docs whenever there are changes and versioning of documentation. The *Read the Docs* project is currently maintained by Stephen Finucane, Russell Bryant and Ben Pfaff. -openvswitch.org ---------------- +ovn.org +------- -The sources for openvswitch.org are maintained separately from -docs.openvswitch.org. For modifications to this site, refer to the `GitHub -project`__. +The sources for ovn.org are maintained separately from docs.ovn.org. For +modifications to this site, refer to the `GitHub project`__. __ http://docutils.sourceforge.net/rst.html __ http://www.sphinx-doc.org/ __ https://github.com/openvswitch/ovs-sphinx-theme __ https://pypi.python.org/pypi/ovs-sphinx-theme -__ https://github.com/openvswitch/openvswitch.github.io +__ https://github.com/ovn-org/ovn-org.github.io diff --git a/Documentation/intro/index.rst b/Documentation/intro/index.rst index c52694d38..f3cf0e53b 100644 --- a/Documentation/intro/index.rst +++ b/Documentation/intro/index.rst @@ -27,7 +27,7 @@ Getting Started =============== -How to get started with Open vSwitch. +How to get started with the Open Virtual Network (OVN). .. toctree:: :maxdepth: 2 diff --git a/Documentation/intro/install/distributions.rst b/Documentation/intro/install/distributions.rst index 705ddd4d2..142f96876 100644 --- a/Documentation/intro/install/distributions.rst +++ b/Documentation/intro/install/distributions.rst @@ -21,9 +21,9 @@ Avoid deeper levels because they do not render well. -==================================== -Distributions packaging Open vSwitch -==================================== +================================================== +Distributions packaging Open Virtual Network (OVN) +================================================== This document lists various popular distributions packaging OVN. diff --git a/Documentation/intro/install/documentation.rst b/Documentation/intro/install/documentation.rst index 9f5014633..cbb2c3591 100644 --- a/Documentation/intro/install/documentation.rst +++ b/Documentation/intro/install/documentation.rst @@ -23,13 +23,13 @@ Avoid deeper levels because they do not render well. -========================== -Open vSwitch Documentation -========================== +======================================== +Open Virtual Network (OVN) Documentation +======================================== -This document describes how to build the OVS documentation for use offline. A -continuously updated, online version can be found at `docs.openvswitch.org -`__. +This document describes how to build the OVN documentation for use offline. A +continuously updated, online version can be found at `docs.ovn.org +`__. .. note:: These instructions provide information on building the documentation locally. @@ -40,7 +40,7 @@ Build Requirements ------------------ As described in the :doc:`/internals/contributing/documentation-style`, the -Open vSwitch documentation is written in reStructuredText and built with +OVN documentation is written in reStructuredText and built with Sphinx. A detailed guide on installing Sphinx in many environments is available on the `Sphinx website`__ but, for most Linux distributions, you can install with your package manager. For example, on Debian/Ubuntu run:: diff --git a/Documentation/intro/install/index.rst b/Documentation/intro/install/index.rst index c061aba78..3e2e415f9 100644 --- a/Documentation/intro/install/index.rst +++ b/Documentation/intro/install/index.rst @@ -23,11 +23,11 @@ Avoid deeper levels because they do not render well. -======================= -Installing Open vSwitch -======================= +===================================== +Installing Open Virtual Network (OVN) +===================================== -A collection of guides detailing how to install Open vSwitch in a variety of +A collection of guides detailing how to install OVN in a variety of different environments and using different configurations. Installation from Source @@ -45,8 +45,8 @@ Installation from Source Installation from Packages -------------------------- -Open vSwitch is packaged on a variety of distributions. The tooling required to -build these packages is included in the Open vSwitch tree. The instructions are +OVN is packaged on a variety of distributions. The tooling required to +build these packages is included in the OVN tree. The instructions are provided below. .. toctree:: diff --git a/Documentation/topics/index.rst b/Documentation/topics/index.rst index eca753f6c..3b689cf53 100644 --- a/Documentation/topics/index.rst +++ b/Documentation/topics/index.rst @@ -45,6 +45,6 @@ OVN .. list-table:: * - ovn-architecture(7) - - `(pdf) `__ - - `(html) `__ - - `(plain text) `__ + - `(pdf) `__ + - `(html) `__ + - `(plain text) `__ diff --git a/ovn-architecture.7.xml b/ovn-architecture.7.xml index 1f8aa2b0e..48e6dc6c3 100644 --- a/ovn-architecture.7.xml +++ b/ovn-architecture.7.xml @@ -1730,7 +1730,7 @@

For more information on L3 gateway high availability, please refer to - http://docs.openvswitch.org/en/latest/topics/high-availability. + http://docs.ovn.org/en/latest/topics/high-availability.

Restrictions of Distributed Gateway Ports

diff --git a/rhel/ovn-fedora.spec.in b/rhel/ovn-fedora.spec.in index 6a59ccc40..6b11ef3e8 100644 --- a/rhel/ovn-fedora.spec.in +++ b/rhel/ovn-fedora.spec.in @@ -28,7 +28,7 @@ Name: ovn Summary: Open Virtual Network support Group: System Environment/Daemons -URL: http://www.openvswitch.org/ +URL: http://www.ovn.org/ Version: @VERSION@ Obsoletes: openvswitch-ovn-common < %{?epoch:%{epoch}:}%{version}-%{release} Provides: openvswitch-ovn-common = %{?epoch:%{epoch}:}%{version}-%{release}