diff mbox

[ovs-dev] doc: Link to release FAQ from DPDK install guide

Message ID 20170407135828.8665-1-stephen@that.guru
State Superseded
Headers show

Commit Message

Stephen Finucane April 7, 2017, 1:58 p.m. UTC
I wanted to find the mappings of DPDK versions to OVS versions. This was
a little more difficult than expected. Resolve the issue by linking to
it from the DPDK install guide.

Signed-off-by: Stephen Finucane <stephen@that.guru>
---
 Documentation/intro/install/dpdk.rst | 5 +++++
 1 file changed, 5 insertions(+)

Comments

Darrell Ball April 7, 2017, 3:28 p.m. UTC | #1
On 4/7/17, 6:58 AM, "ovs-dev-bounces@openvswitch.org on behalf of Stephen Finucane" <ovs-dev-bounces@openvswitch.org on behalf of stephen@that.guru> wrote:

    I wanted to find the mappings of DPDK versions to OVS versions. This was
    a little more difficult than expected. Resolve the issue by linking to
    it from the DPDK install guide.
    
    Signed-off-by: Stephen Finucane <stephen@that.guru>

    ---
     Documentation/intro/install/dpdk.rst | 5 +++++
     1 file changed, 5 insertions(+)
    
    diff --git a/Documentation/intro/install/dpdk.rst b/Documentation/intro/install/dpdk.rst
    index b947bd5..f29ac05 100644
    --- a/Documentation/intro/install/dpdk.rst
    +++ b/Documentation/intro/install/dpdk.rst
    @@ -29,6 +29,11 @@ This document describes how to build and install Open vSwitch using a DPDK
     datapath. Open vSwitch can use the DPDK library to operate entirely in
     userspace.
     
    +.. seealso::
    +
    +    The :doc:`releases FAQ </faq/releases>` lists support for the required
    +    versions of DPDK for each version of Open vSwitch.
    +

If it is not intuitive to follow the path 
Open vswitch Documentation -> FAQ -> Releases, 
then perhaps it means
“Releases” should also be linked at the same level as Installation Guides, Tutorials etc
Releases is really one of first high topics people are interested in.

     Build requirements
     ------------------
     
    -- 
    2.9.3
    
    _______________________________________________
    dev mailing list
    dev@openvswitch.org
    https://urldefense.proofpoint.com/v2/url?u=https-3A__mail.openvswitch.org_mailman_listinfo_ovs-2Ddev&d=DwICAg&c=uilaK90D4TOVoH58JNXRgQ&r=BVhFA09CGX7JQ5Ih-uZnsw&m=JuMHvMF593An6bmUdA53FDJbvtIOv9cN_jB-hLsfvF8&s=RpGW4MegZxxYy-B1w4Jbcv815A_WkzAOl8LJbBiuDBU&e=
Stephen Finucane April 10, 2017, 2:10 p.m. UTC | #2
On Fri, 2017-04-07 at 15:28 +0000, Darrell Ball wrote:
> 
> On 4/7/17, 6:58 AM, "ovs-dev-bounces@openvswitch.org on behalf of
> Stephen Finucane" <ovs-dev-bounces@openvswitch.org on behalf of steph
> en@that.guru> wrote:
> 
>     I wanted to find the mappings of DPDK versions to OVS versions.
> This was
>     a little more difficult than expected. Resolve the issue by
> linking to
>     it from the DPDK install guide.
>     
>     Signed-off-by: Stephen Finucane <stephen@that.guru>
>     ---
>      Documentation/intro/install/dpdk.rst | 5 +++++
>      1 file changed, 5 insertions(+)
>     
>     diff --git a/Documentation/intro/install/dpdk.rst
> b/Documentation/intro/install/dpdk.rst
>     index b947bd5..f29ac05 100644
>     --- a/Documentation/intro/install/dpdk.rst
>     +++ b/Documentation/intro/install/dpdk.rst
>     @@ -29,6 +29,11 @@ This document describes how to build and
> install Open vSwitch using a DPDK
>      datapath. Open vSwitch can use the DPDK library to operate
> entirely in
>      userspace.
>      
>     +.. seealso::
>     +
>     +    The :doc:`releases FAQ </faq/releases>` lists support for
> the required
>     +    versions of DPDK for each version of Open vSwitch.
>     +
> 
> If it is not intuitive to follow the path 
> Open vswitch Documentation -> FAQ -> Releases, 
> then perhaps it means
> “Releases” should also be linked at the same level as Installation
> Guides, Tutorials etc
> Releases is really one of first high topics people are interested in.

That would apply if you're navigating the docs from '/' and I see merit
in doing that. I'll reroll a v2 shortly. However, this wouldn't help
users navigating to the page from Google (like I was) and I think we
should keep this change itself.

> 
>      Build requirements
>      ------------------
>      
>     -- 
>     2.9.3
>     

Stephen
Darrell Ball April 12, 2017, 12:07 a.m. UTC | #3
On 4/10/17, 7:10 AM, "Stephen Finucane" <stephen@that.guru> wrote:

    On Fri, 2017-04-07 at 15:28 +0000, Darrell Ball wrote:
    > 

    > On 4/7/17, 6:58 AM, "ovs-dev-bounces@openvswitch.org on behalf of

    > Stephen Finucane" <ovs-dev-bounces@openvswitch.org on behalf of steph

    > en@that.guru> wrote:

    > 

    >     I wanted to find the mappings of DPDK versions to OVS versions.

    > This was

    >     a little more difficult than expected. Resolve the issue by

    > linking to

    >     it from the DPDK install guide.

    >     

    >     Signed-off-by: Stephen Finucane <stephen@that.guru>

    >     ---

    >      Documentation/intro/install/dpdk.rst | 5 +++++

    >      1 file changed, 5 insertions(+)

    >     

    >     diff --git a/Documentation/intro/install/dpdk.rst

    > b/Documentation/intro/install/dpdk.rst

    >     index b947bd5..f29ac05 100644

    >     --- a/Documentation/intro/install/dpdk.rst

    >     +++ b/Documentation/intro/install/dpdk.rst

    >     @@ -29,6 +29,11 @@ This document describes how to build and

    > install Open vSwitch using a DPDK

    >      datapath. Open vSwitch can use the DPDK library to operate

    > entirely in

    >      userspace.

    >      

    >     +.. seealso::

    >     +

    >     +    The :doc:`releases FAQ </faq/releases>` lists support for

    > the required

    >     +    versions of DPDK for each version of Open vSwitch.

    >     +

    > 

    > If it is not intuitive to follow the path 

    > Open vswitch Documentation -> FAQ -> Releases, 

    > then perhaps it means

    > “Releases” should also be linked at the same level as Installation

    > Guides, Tutorials etc

    > Releases is really one of first high topics people are interested in.

    
    That would apply if you're navigating the docs from '/' and I see merit
    in doing that. I'll reroll a v2 shortly. However, this wouldn't help
    users navigating to the page from Google (like I was) and I think we
    should keep this change itself.

Having both is what I was getting at; that is what I meant by “also”.
Thanks

    
    > 

    >      Build requirements

    >      ------------------

    >      

    >     -- 

    >     2.9.3

    >     

    
    Stephen
diff mbox

Patch

diff --git a/Documentation/intro/install/dpdk.rst b/Documentation/intro/install/dpdk.rst
index b947bd5..f29ac05 100644
--- a/Documentation/intro/install/dpdk.rst
+++ b/Documentation/intro/install/dpdk.rst
@@ -29,6 +29,11 @@  This document describes how to build and install Open vSwitch using a DPDK
 datapath. Open vSwitch can use the DPDK library to operate entirely in
 userspace.
 
+.. seealso::
+
+    The :doc:`releases FAQ </faq/releases>` lists support for the required
+    versions of DPDK for each version of Open vSwitch.
+
 Build requirements
 ------------------