From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mga02.intel.com (mga02.intel.com [134.134.136.20]) by dpdk.org (Postfix) with ESMTP id 18495C388 for ; Fri, 10 Jul 2015 17:39:15 +0200 (CEST) Received: from fmsmga001.fm.intel.com ([10.253.24.23]) by orsmga101.jf.intel.com with ESMTP; 10 Jul 2015 08:39:14 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.15,447,1432623600"; d="scan'208";a="744539528" Received: from irsmsx153.ger.corp.intel.com ([163.33.192.75]) by fmsmga001.fm.intel.com with ESMTP; 10 Jul 2015 08:39:14 -0700 Received: from irsmsx156.ger.corp.intel.com (10.108.20.68) by IRSMSX153.ger.corp.intel.com (163.33.192.75) with Microsoft SMTP Server (TLS) id 14.3.224.2; Fri, 10 Jul 2015 16:39:13 +0100 Received: from irsmsx103.ger.corp.intel.com ([169.254.3.216]) by IRSMSX156.ger.corp.intel.com ([169.254.3.125]) with mapi id 14.03.0224.002; Fri, 10 Jul 2015 16:39:13 +0100 From: "Mcnamara, John" To: Thomas Monjalon Thread-Topic: [dpdk-dev] [PATCH 2/3] doc: added guidelines on dpdk documentation Thread-Index: AQHQtM4m/b0ys3sl1Uuuc+XJUbTXVJ3IS7GAgAyT8VA= Date: Fri, 10 Jul 2015 15:39:12 +0000 Message-ID: References: <1435845053-17203-1-git-send-email-john.mcnamara@intel.com> <1435845053-17203-3-git-send-email-john.mcnamara@intel.com> <1986693.jIPruNIANr@xps13> In-Reply-To: <1986693.jIPruNIANr@xps13> Accept-Language: en-US Content-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: x-originating-ip: [163.33.239.181] Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 Cc: "dev@dpdk.org" Subject: Re: [dpdk-dev] [PATCH 2/3] doc: added guidelines on dpdk documentation X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: patches and discussions about DPDK List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 10 Jul 2015 15:39:16 -0000 > -----Original Message----- > From: Thomas Monjalon [mailto:thomas.monjalon@6wind.com] > Sent: Thursday, July 2, 2015 5:21 PM > To: Mcnamara, John > Cc: dev@dpdk.org > Subject: Re: [dpdk-dev] [PATCH 2/3] doc: added guidelines on dpdk > documentation > > Good idea to have guidelines for doc. > But I think the submission guidelines shouldn't be specific to doc. > Could you move it to a contributing.rst file? > Guidelines from the website could be moved there. Hi Thomas, I've removed the doc contributing guidelines and will resubmit at a later s= tage reworked as a more general contribution guidelines based on the inform= ation on dpdk.org. Other comments have been integrated in V2 apart from the one below. > > +* The use of a label is preferred since it works across files and > > +will still > > + work if the header text changes. >=20 > Artificial labels are a bit ugly. > If a header change, there will be an error for the link, right? Most RST directives are ugly. Labels have the advantage of being explicit, = and from what I can see, are widely used. Here are the recommendations from= the Sphinx guide: Using ref is advised over standard reStructuredText links to sections (like `Section title`_) because it works across files, when section headings are changed, and for all builders that support cross-references. http://sphinx-doc.org/markup/inline.html#ref-role John. --=20