[dpdk-web] [PATCH 1/2] charter: standardize numbering

[dpdk-web] [PATCH 1/2] charter: standardize numbering

[Thomas Monjalon]

Use the same numbering format in every sections:
	1.a.i.1

Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com>
---
 about/charter.html | 82 ++++++++++++++++++++++++++----------------------------
 content.css        |  9 ++++++
 2 files changed, 49 insertions(+), 42 deletions(-)

diff --git a/about/charter.html b/about/charter.html
index eb8b0ba..1130cac 100644
--- a/about/charter.html
+++ b/about/charter.html
@@ -42,7 +42,7 @@
 <h2 id="mission">Mission of the Data Plane Development Kit Project</h2>
 <p>
 	The mission of DPDK is to:
-<ol type="a">
+<ol>
 	<li>
 		Create an open source, production quality, vendor neutral
 		software platform for enabling fast dataplane I/O,
@@ -80,7 +80,7 @@
 <h2 id="governance">Project Governance</h2>
 <p>
 	Governance for DPDK will be provided by two boards:
-<ol type="1">
+<ol>
 	<li>
 		A Governing Board which deals with budget, marketing,
 		lab resources, administrative, legal and licensing issues.
@@ -98,12 +98,12 @@
 <p>
 	The Governing Board covers the full scope of DPDK, including all sub-projects.
 	Responsibilities of the Governing Board are:
-<ol type="i">
+<ol>
 	<li>
 		Electing a Chair to preside over meetings,
 		authorize expenditures approved by the Governing Board,
 		and manage any day-to-day operations.
-	<ol type="a">
+	<ol>
 		<li>
 			The Chair will be elected on an annual basis.
 		<li>
@@ -145,13 +145,13 @@
 <h4 id="govcomposition">Composition</h4>
 <p>
 	The Governing Board shall consist of:
-<ol type="i">
+<ol>
 	<li>
 		One representative appointed by each Gold Member
-		as specified in <a href="#goldrep">clause 4.d.a</a> below.
+		as specified in <a href="#goldrep">clause 4.d.i</a> below.
 	<li>
 		Up to two Silver Member representatives
-		as specified in <a href="#silverrep">clause 4.e.a</a> below.
+		as specified in <a href="#silverrep">clause 4.e.i</a> below.
 	<li>
 		One representative of the Technical Board,
 		to be nominated by the Technical Board on an annual basis.
@@ -160,7 +160,7 @@
 <h4 id="govconduct">Conduct</h4>
 <p>
 	Conduct of Governing Board meetings:
-<ol type="i">
+<ol>
 	<li>
 		Governing Board meetings shall be limited to
 		the Governing Board representatives,
@@ -177,7 +177,7 @@
 		(<em>not</em> just a &frac23; majority of those in attendance at the meeting).
 		In the event of a deadlock the Governing Board Chair
 		shall have the casting vote.
-	<ol type="a">
+	<ol>
 		<li>
 			Approval of any exceptions to the Intellectual Property Policy
 			(see <a href="#licexception">section 6.c</a>).
@@ -217,11 +217,11 @@
 	A separate Technical Board may be established for other sub-projects
 	in future if any of them grows sufficiently large to require one.
 	Responsibilities of the Technical Board are:
-<ol type="i">
+<ol>
 	<li>
 		Electing a Chair to preside over meetings,
 		and manage any day-to-day operations.
-	<ol type="a">
+	<ol>
 		<li>
 			The Chair will be elected on an annual basis.
 		<li>
@@ -235,7 +235,7 @@
 		will be defined by the Technical Board.
 		The Technical Board will apply non-technical criteria
 		for new sub-projects that are defined by the Governing Board
-		(see <a href="#subprojcriteria">section 3.1.1, point ix</a>)
+		(see <a href="#subprojcriteria">section 3.1.1, point i</a>)
 		when making its decision on proposed new projects.
 		Requests can be submitted by emailing
 		<a href="mailto:techboard@dpdk.org">techboard@dpdk.org</a>.
@@ -277,13 +277,13 @@
 <h4 id="techcomposition">Composition</h4>
 <p>
 	The Technical Board shall consist of:
-<ol type="i">
+<ol>
 	<li>
 		The composition of the Technical Board is documented at:
 		<a href="/about/techboard">http://dpdk.org/about/techboard</a>.
 	<li>
 		To be added to or removed from the Technical Board:
-	<ol type="a">
+	<ol>
 		<li>
 			A candidate must be nominated by an existing member of the Technical Board and
 		<li>
@@ -291,7 +291,7 @@
 	</ol>
 	<li>
 		When adding or removing members, the Technical Board must consider the following:
-	<ol type="a">
+	<ol>
 		<li>
 			Positions on the Technical Board are determined based on technical merit.
 			A new member must have a strong history of contribution
@@ -311,7 +311,7 @@
 <h4 id="techconduct">Conduct</h4>
 <p>
 	Conduct of Technical Board meetings:
-<ol type="i">
+<ol>
 	<li>
 		Technical Board meetings shall be open to the public.
 	<li>
@@ -327,7 +327,7 @@
 </ol>
 
 <h2 id="membership">Membership</h2>
-<ol type="a">
+<ol>
 	<li>
 		DPDK is a free, open source project that welcomes all contributors.
 		Anybody can use or contribute to DPDK.
@@ -353,7 +353,7 @@
 		may from time to time adopt with notice to members.
 	<li>
 		Gold Members shall be entitled to:
-	<ol type="a">
+	<ol>
 		<li id="goldrep">
 			Appoint a representative to the Governing Board
 			and any other committees established by the Governing Board.
@@ -370,7 +370,7 @@
 	</ol>
 	<li>
 		Silver Members shall be entitled to:
-	<ol type="a">
+	<ol>
 		<li id="silverrep">
 			Annually elect one representative to the Governing Board
 			and any other committees established by the Governing Board
@@ -392,7 +392,7 @@
 	<li id="lab">
 		Gold and Silver Members shall be entitled to participate in
 		an open DPDK Project performance lab (if created):
-	<ol type="a">
+	<ol>
 		<li>
 			They will be able to contribute hardware
 			to be hosted in the lab for DPDK performance testing.
@@ -421,7 +421,7 @@
 	Beyond that, each sub-project within DPDK shall be responsible
 	for its own technical governance and technical decision making,
 	including issues such as:
-<ol type="a">
+<ol>
 	<li>
 		Determining the process and tools to be used
 		for development, CI, validation etc.
@@ -447,18 +447,18 @@
 	>http://dpdk.org/browse/apps/pktgen-dpdk/tree/CONTRIBUTING.TXT</a> for an example.
 
 <h2 id="ip">Intellectual Property Policy</h2>
-<ol type="a">
+<ol>
 	<li>
 		All new inbound contributions to DPDK
 		shall be made under the following licenses:
-	<ol type="a">
+	<ol>
 		<li>
 			The GPLv2 license
 			(<a href="https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html"
 			>https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html</a>)
 			shall be used for code that runs in the kernel.
 			Current examples of this are:
-		<ol type="i">
+		<ol>
 			<li>
 				lib/librte_eal/linuxapp/igb_uio
 			<li>
@@ -481,10 +481,10 @@
 			>https://www.gnu.org/licenses/old-licenses/lgpl-2.0.en.html</a>)
 			shall be used for code that is shared between the kernel and userspace.
 			Current examples of this are:
-		<ol type="i">
+		<ul>
 			<li>
 				BSD/GPLv2:
-			<ol type="1">
+			<ol>
 				<li>
 					All files in: drivers/crypto/qat/qat_adf/
 				<li>
@@ -496,14 +496,14 @@
 			</ol>
 			<li>
 				BSD/LGPLv2:
-			<ol type="1">
+			<ol start="4">
 				<li>
 					lib/librte_eal/bsdapp/eal/include/exec-env/rte_dom0_common.h
 				<li>
 					lib/librte_eal/linuxapp/eal/include/exec-env/rte_dom0_common.h,
 					rte_kni_common.h
 			</ol>
-		</ol>
+		</ul>
 		<li>
 			The 3-clause BSD license
 			(<a href="https://opensource.org/licenses/BSD-3-Clause"
@@ -533,7 +533,7 @@
 </ol>
 
 <h2 id="budget">Budget</h2>
-<ol type="a">
+<ol>
 	<li>
 		The Governing Board shall approve an annual budget
 		and never commit to spend in excess of funds raised.
@@ -550,13 +550,13 @@
 		arises related to DPDK, The Linux Foundation will coordinate
 		with the Governing Board to address gap funding requirements.
 	<li>
-		As described in <a href="#govtransp">3.1.3 clause v</a>,
+		As described in <a href="#govtransp">3.1.3 clause e</a>,
 		the Governing Board will publish a public version of the budget.
 		Questions on the budget should be addressed to the Governing Board.
 </ol>
 
 <h2 id="expenses">General &amp; Administrative Expenses</h2>
-<ol type="a">
+<ol>
 	<li>
 		The Linux Foundation shall have custody of and final authority
 		over the usage of any fees, funds and other cash receipts.
@@ -573,7 +573,7 @@
 </ol>
 
 <h2 id="antitrust">Antitrust Guidelines</h2>
-<ol type="a">
+<ol>
 	<li>
 		All members shall abide by The Linux Foundation Antitrust Policy
 		available at <a href="http://www.linuxfoundation.org/antitrust-policy">
@@ -588,7 +588,7 @@
 </ol>
 
 <h2 id="coc">Code of Conduct</h2>
-<ol type="a">
+<ol>
 	<li>
 		The Governing Board may adopt a specific Project code of conduct,
 		with approval from the LF.
@@ -602,7 +602,7 @@
 <h2 id="genrules">General Rules and Operations</h2>
 <p>
 	The DPDK project shall be conducted so as to:
-<ol type="a">
+<ol>
 	<li>
 		Engage in the work of the project in a professional manner
 		consistent with maintaining a cohesive community,
@@ -628,13 +628,11 @@
 </ol>
 
 <h2 id="amendments">Amendments</h2>
-<ol type="a">
-	<li>
-		This charter may be amended by a two-thirds vote of
-		the entire Governing Board,
-		subject to approval by The Linux Foundation.
-		Proposed changes must be communicated publicly
-		to the community prior to being approved by the Governing Board.
-</ol>
+<p>
+	This charter may be amended by a two-thirds vote of
+	the entire Governing Board,
+	subject to approval by The Linux Foundation.
+	Proposed changes must be communicated publicly
+	to the community prior to being approved by the Governing Board.
 
 </section>
diff --git a/content.css b/content.css
index 4336558..2d94ec3 100644
--- a/content.css
+++ b/content.css
@@ -168,6 +168,15 @@ section#charter ol {
 	text-align: justify;
 	text-justify: inter-word;
 }
+section#charter ol {
+	list-style-type: lower-latin;
+}
+section#charter ol ol {
+	list-style-type: lower-roman;
+}
+section#charter ol ol ol {
+	list-style-type: lower-decimal;
+}
 section#charter li {
 	margin-top: 0.6em;
 }
-- 
2.7.0

[dpdk-web] [PATCH 2/2] charter: simplify description of links

[Thomas Monjalon]

The charter was written without hyperlink support.
The links are revisited now that it is in HTML format.

Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com>
---
 about/charter.html | 100 ++++++++++++++++++++++++++---------------------------
 1 file changed, 50 insertions(+), 50 deletions(-)

diff --git a/about/charter.html b/about/charter.html
index 1130cac..9fdf094 100644
--- a/about/charter.html
+++ b/about/charter.html
@@ -65,13 +65,13 @@
 	which are used to apply changes to specific parts of DPDK
 	before these are pulled into the master repository,
 	and a stable release repository.
-	This structure is documented at:
-	<a href= "/browse/">http://dpdk.org/browse/</a>.
+	This structure is listed in
+	the <a href= "/browse/">repository home page</a>.
 <p>
 	The sub-projects that are also hosted as part of the DPDK Project
 	are typically applications that are closely related to DPDK.
-	These are listed at:
-	<a href= "/browse/">http://dpdk.org/browse/</a>.
+	These can be browsed in
+	the <a href= "/browse/">repository home page</a>.
 <p>
 	Changes to this structure, including approval for any new sub-projects,
 	are the responsibility of the Technical Board
@@ -180,7 +180,7 @@
 	<ol>
 		<li>
 			Approval of any exceptions to the Intellectual Property Policy
-			(see <a href="#licexception">section 6.c</a>).
+			(see <a href="#licexception">clause 6.c</a>).
 		<li>
 			Approval of any changes to this document
 			(see <a href="#amendments">section 12</a>).
@@ -235,7 +235,7 @@
 		will be defined by the Technical Board.
 		The Technical Board will apply non-technical criteria
 		for new sub-projects that are defined by the Governing Board
-		(see <a href="#subprojcriteria">section 3.1.1, point i</a>)
+		(see <a href="#subprojcriteria">clause 3.1.1.i</a>)
 		when making its decision on proposed new projects.
 		Requests can be submitted by emailing
 		<a href="mailto:techboard@dpdk.org">techboard@dpdk.org</a>.
@@ -279,8 +279,8 @@
 	The Technical Board shall consist of:
 <ol>
 	<li>
-		The composition of the Technical Board is documented at:
-		<a href="/about/techboard">http://dpdk.org/about/techboard</a>.
+		The composition of the Technical Board is documented at
+		<a href="/about/techboard#members">dpdk.org/about/techboard#members</a>.
 	<li>
 		To be added to or removed from the Technical Board:
 	<ol>
@@ -339,9 +339,8 @@
 		All Gold and Silver Members must be current
 		corporate members of The Linux Foundation (at any level).
 		Details of LF membership levels and rates are available in
-		The Linux Foundation Bylaws
 		<a href="https://www.linuxfoundation.org/about/bylaws">
-		https://www.linuxfoundation.org/about/bylaws</a>.
+		The Linux Foundation Bylaws</a>.
 	<li>
 		All Gold and Silver Members enjoy the privileges
 		and undertake the obligations described in this DPDK Project Charter,
@@ -359,7 +358,7 @@
 			and any other committees established by the Governing Board.
 		<li>
 			Participate in an open DPDK performance lab
-			as outlined in <a href="#lab">section 4, clause f</a> below.
+			as outlined in <a href="#lab">clause 4.f</a> below.
 		<li>
 			Be prominently identified as Gold sponsors of the project
 			at DPDK-funded events.
@@ -380,7 +379,7 @@
 			and published publicly by the Governing Board.
 		<li>
 			Participate in an open DPDK performance lab
-			as outlined in <a href="#lab">section 4, clause f</a> below.
+			as outlined in <a href="#lab">clause 4.f</a> below.
 		<li>
 			Be identified as Silver sponsors of the project
 			at DPDK-funded events.
@@ -434,17 +433,14 @@
 </ol>
 <p>
 	For the core DPDK project, technical governance is documented in
-	the Contributor's Guidelines
-	(<a href="/doc/guides/contributing/"
-	>http://dpdk.org/doc/guides/contributing/</a>)
-	and on the DPDK.org Development web page
-	(<a href="/dev/">http://dpdk.org/dev</a>).
+	the <a href="/doc/guides/contributing/">Contributor's Guidelines</a>
+	and on the <a href="/dev/">Development web page</a>.
 <p>
 	For the other sub-projects within DPDK,
 	technical governance will be documented in a CONTRIBUTING.txt file
 	in the root directory for the sub-project.
 	See <a href="/browse/apps/pktgen-dpdk/tree/CONTRIBUTING.TXT"
-	>http://dpdk.org/browse/apps/pktgen-dpdk/tree/CONTRIBUTING.TXT</a> for an example.
+	>pktgen-dpdk/tree/CONTRIBUTING.TXT</a> for an example.
 
 <h2 id="ip">Intellectual Property Policy</h2>
 <ol>
@@ -453,9 +449,8 @@
 		shall be made under the following licenses:
 	<ol>
 		<li>
-			The GPLv2 license
-			(<a href="https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html"
-			>https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html</a>)
+			The <a href="https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html"
+			>GPLv2 license</a>
 			shall be used for code that runs in the kernel.
 			Current examples of this are:
 		<ol>
@@ -469,16 +464,15 @@
 				lib/librte_eal/linuxapp/kni/ethtool/ixgbe
 		</ol>
 		<li>
-			A dual 3-clause BSD/GPLv2 license
-			(<a href="https://opensource.org/licenses/BSD-3-Clause"
-			>https://opensource.org/licenses/BSD-3-Clause</a>,
+			A dual
+			<a href="https://opensource.org/licenses/BSD-3-Clause"
+			>3-clause BSD</a>/
 			<a href="https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html"
-			>https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html</a>)
-			or 3-clause BSD/LGPLv2 license
-			(<a href="https://opensource.org/licenses/BSD-3-Clause"
-			>https://opensource.org/licenses/BSD-3-Clause</a>,
+			>GPLv2</a> license or
+			<a href="https://opensource.org/licenses/BSD-3-Clause"
+			>3-clause BSD</a>/
 			<a href="https://www.gnu.org/licenses/old-licenses/lgpl-2.0.en.html"
-			>https://www.gnu.org/licenses/old-licenses/lgpl-2.0.en.html</a>)
+			>LGPLv2</a> license
 			shall be used for code that is shared between the kernel and userspace.
 			Current examples of this are:
 		<ul>
@@ -486,36 +480,43 @@
 				BSD/GPLv2:
 			<ol>
 				<li>
-					All files in: drivers/crypto/qat/qat_adf/
+					All files in
+					<a href="/browse/dpdk/tree/drivers/crypto/qat/qat_adf/"
+					>qat_adf</a>
 				<li>
-					lib/librte_eal/common/include/rte_pci_dev_features.h,
-					rte_pci_dev_feature_defs.h
+					<a href="/browse/dpdk/tree/lib/librte_eal/common/include/rte_pci_dev_features.h"
+					>rte_pci_dev_features.h</a>,
+					<a href="/browse/dpdk/tree/lib/librte_eal/common/include/rte_pci_dev_feature_defs.h"
+					>rte_pci_dev_feature_defs.h</a>
 				<li>
-					lib/librte_eal/linuxapp/xen_dom0/dom0_mm_dev.h,
-					dom0_mm_misc.c
+					<a href="/browse/dpdk/tree/lib/librte_eal/linuxapp/xen_dom0/dom0_mm_dev.h"
+					>dom0_mm_dev.h</a>,
+					<a href="/browse/dpdk/tree/lib/librte_eal/linuxapp/xen_dom0/dom0_mm_misc.c"
+					>dom0_mm_misc.c</a>
 			</ol>
 			<li>
 				BSD/LGPLv2:
 			<ol start="4">
 				<li>
-					lib/librte_eal/bsdapp/eal/include/exec-env/rte_dom0_common.h
+					<a href="/browse/dpdk/tree/lib/librte_eal/bsdapp/eal/include/exec-env/rte_dom0_common.h"
+					>rte_dom0_common.h</a>
 				<li>
-					lib/librte_eal/linuxapp/eal/include/exec-env/rte_dom0_common.h,
-					rte_kni_common.h
+					<a href="/browse/dpdk/tree/lib/librte_eal/linuxapp/eal/include/exec-env/rte_dom0_common.h"
+					>rte_dom0_common.h</a>,
+					<a href="/browse/dpdk/tree/lib/librte_eal/linuxapp/eal/include/exec-env/rte_kni_common.h"
+					>rte_kni_common.h</a>
 			</ol>
 		</ul>
 		<li>
-			The 3-clause BSD license
-			(<a href="https://opensource.org/licenses/BSD-3-Clause"
-			>https://opensource.org/licenses/BSD-3-Clause</a>)
+			The <a href="https://opensource.org/licenses/BSD-3-Clause"
+			>3-clause BSD license</a>
 			shall be used for all other contributions.
 	</ol>
 	<li>
 		All contributions shall include a "Signed-off-by:" line
 		which certifies that the contribution complies with
-		the Developer Certificate of Origin
-		(<a href="http://developercertificate.org"
-		>http://developercertificate</a>).
+		the <a href="http://developercertificate.org"
+		>Developer Certificate of Origin</a>.
 	<li id="licexception">
 		If an alternative inbound or outbound license is required
 		for compliance with the license for a leveraged open source project
@@ -550,7 +551,7 @@
 		arises related to DPDK, The Linux Foundation will coordinate
 		with the Governing Board to address gap funding requirements.
 	<li>
-		As described in <a href="#govtransp">3.1.3 clause e</a>,
+		As described in <a href="#govtransp">clause 3.1.3.e</a>,
 		the Governing Board will publish a public version of the budget.
 		Questions on the budget should be addressed to the Governing Board.
 </ol>
@@ -575,9 +576,9 @@
 <h2 id="antitrust">Antitrust Guidelines</h2>
 <ol>
 	<li>
-		All members shall abide by The Linux Foundation Antitrust Policy
-		available at <a href="http://www.linuxfoundation.org/antitrust-policy">
-		http://www.linuxfoundation.org/antitrust-policy</a>.
+		All members shall abide by
+		<a href="http://www.linuxfoundation.org/antitrust-policy"
+		>The Linux Foundation Antitrust Policy</a>.
 	<li>
 		All members shall encourage open participation
 		from any organization able to meet the membership requirements,
@@ -594,9 +595,8 @@
 		with approval from the LF.
 	<li>
 		All participants in LF Project events shall abide by
-		The Linux Foundation Events Code of Conduct, available at:
-		<a href="http://events.linuxfoundation.org/EVENT-CODE-OF-CONDUCT">
-		http://events.linuxfoundation.org/EVENT-CODE-OF-CONDUCT</a>.
+		<a href="http://events.linuxfoundation.org/EVENT-CODE-OF-CONDUCT"
+		>The Linux Foundation Events Code of Conduct</a>.
 </ol>
 
 <h2 id="genrules">General Rules and Operations</h2>
-- 
2.7.0

Re: [dpdk-web] [PATCH 1/2] charter: standardize numbering

[Thomas Monjalon]

Hi,

There was no comment about this patch.
Is it OK to change the numbering of the charter to make it simpler?

31/03/2017 18:44, Thomas Monjalon:
> Use the same numbering format in every sections:
> 	1.a.i.1
> 
> Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com>

Re: [dpdk-web] [PATCH 1/2] charter: standardize numbering

[Thomas Monjalon]

31/03/2017 18:44, Thomas Monjalon:
> Use the same numbering format in every sections:
> 	1.a.i.1
> 
> Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com>

Applied, as there was no comment after 6 months, and asked recently:
	http://dpdk.org/ml/archives/web/2017-October/000479.html