From mboxrd@z Thu Jan  1 00:00:00 1970
From: Thomas Monjalon <thomas@monjalon.net>
Subject: Re: [PATCH v6] doc: document NIC features
Date: Fri, 04 Aug 2017 12:10:11 +0200
Message-ID: <3910772.dyrDr9423A@xps>
References: <20170720092303.97525-1-ferruh.yigit@intel.com>
 <1557856.DY0fuUa5Sa@xps> <9e854181-70a1-810d-8e6e-ebf6589bab00@intel.com>
Mime-Version: 1.0
Content-Type: text/plain; charset="us-ascii"
Content-Transfer-Encoding: 7Bit
Cc: dev@dpdk.org, John McNamara <john.mcnamara@intel.com>,
 Olivier Matz <olivier.matz@6wind.com>
To: Ferruh Yigit <ferruh.yigit@intel.com>
Return-path: <dev-bounces@dpdk.org>
Received: from out1-smtp.messagingengine.com (out1-smtp.messagingengine.com
 [66.111.4.25]) by dpdk.org (Postfix) with ESMTP id 01D052BC9
 for <dev@dpdk.org>; Fri,  4 Aug 2017 12:10:24 +0200 (CEST)
In-Reply-To: <9e854181-70a1-810d-8e6e-ebf6589bab00@intel.com>
List-Id: DPDK patches and discussions <dev.dpdk.org>
List-Unsubscribe: <http://dpdk.org/ml/options/dev>,
 <mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://dpdk.org/ml/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <http://dpdk.org/ml/listinfo/dev>,
 <mailto:dev-request@dpdk.org?subject=subscribe>
Errors-To: dev-bounces@dpdk.org
Sender: "dev" <dev-bounces@dpdk.org>

04/08/2017 12:04, Ferruh Yigit:
> On 8/4/2017 10:32 AM, Thomas Monjalon wrote:
> > 04/08/2017 10:56, Ferruh Yigit:
> >> On 8/3/2017 11:57 PM, Thomas Monjalon wrote:
> >>> 01/08/2017 17:23, Ferruh Yigit:
> >>>> +:orphan:
> >>>> +
> >>>> +.. _nic_overview_features:
> >>>
> >>> Why have you done an orphan page?
> >>> I think it should be in doc/guides/nics/overview.rst 
> >>
> >> There is a link from nics/overview.rst to this file. But this file is
> >> not in the index and not making it orphan is causing a build warning.
> > 
> > But why creating a new page?
> > It could be below the table in overview.rst.
> 
> Overview page is mostly just a table, this is more simple and clean I
> believe.
> 
> Instead, I was thinking to be able to find a way to make each feature
> name a link to its description in this file.

Could we have a link to a section in the same page?

My main concern is that orphan page is weird in sphinx.
And from a usability point of view, users prefer looking for pages
from the menu at the left.