[Xen-API] [PATCH 2/3] Added comment sections to highight problem areas

[Lars Kurth <lars.kurth@xxxxxxxxxx>]

These are marked by
-------------------------------------------------------------------------
...
-------------------------------------------------------------------------
blocks that will be removed in the published version

Signed-off-by: Lars Kurth <lars.kurth@xxxxxxxxxx>
---
 governance.pandoc | 91 +++++++++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 88 insertions(+), 3 deletions(-)

diff --git a/governance.pandoc b/governance.pandoc
index 2ce780c..86e4433 100644
--- a/governance.pandoc
+++ b/governance.pandoc
@@ -1,3 +1,4 @@
+
 This document has come in effect in June 2011 and will be reviewed 
periodically 
 (see revision sections). The last modification has been made in July 2016.
 
@@ -54,8 +55,23 @@ The Xen Project is a meritocracy. The more you contribute 
the more
 responsibility you will earn. Leadership roles in Xen are also merit-based and 
 earned by peer acclaim.
 
+    
+    
-------------------------------------------------------------------------------------
+    I moved the "Roles" section up and split it into two sections with 
unmodified content
+    - Xen Project Wide Roles
+    - Project Team Roles
+    
-------------------------------------------------------------------------------------
+
 Xen Project Wide Roles {#roles-global}
 ----------------------
+    
+    
-------------------------------------------------------------------------------------
+    MINOR ISSUES TO BE ADDRESSED LATER: 
+    - Sub-projects and Teams would benefit from some forward references to 
highlight the 
+      difference between incubation mature projects.
+    - Also we should clarify what assets a sub-project owns. 
+    - Add the role of Community Manager as it used throughout the document
+    
-------------------------------------------------------------------------------------
 
 ### Sub-projects and Teams
 
@@ -103,6 +119,15 @@ behind the project.
 Project Team Roles {#roles-local}
 ------------------
 
+    
-------------------------------------------------------------------------------------
+    ISSUES TO BE ADDRESSED LATER: 
+    - Fix minor Inaccuracies and Improvements
+    - Allow for customization of roles by sub-projects (but this definition is 
the default)
+    - Allow for Security Response Team
+    - Allow for sub-projects to be lead by a Project Leadership Team (which 
may include a 
+      Project Lead)
+    
-------------------------------------------------------------------------------------
+
 ### Maintainers
 
 Maintainers own one or several components in the Xen tree. A maintainer 
reviews 
@@ -131,6 +156,10 @@ referees should disagreements amongst committers of the 
project arise. The
 project lead typically also has write access to resources, such as the web 
page 
 of a specific project.
 
+    
-------------------------------------------------------------------------------------
+    Moved this section 
+    
-------------------------------------------------------------------------------------
+
 Making Contributions {#contributions}
 --------------------
 
@@ -147,18 +176,46 @@ documents:
 
 -   [Contribution Guidelines](/help/contribution-guidelines.html)
 
-Decision Making, Conflict Resolution, Role Nominations and Elections 
-{#decisions}
+    
-------------------------------------------------------------------------------------
+    Consolidated all Decision Making Related topics into one section 
+    - I changed the order of the sections from ...
+      "Consensus Decision Making, Conflict Resolution, Elections and Formal 
Votes" to 
+      "Consensus Decision Making, Formal Votes, Conflict Resolution, Elections"
+    - I changed header titles and fixed the headline  
+
+    Otherwise the relevant sections remain identical, with the exception of 
comment 
+    sections that I added, which highlight issues that are to be addressed.
+    
-------------------------------------------------------------------------------------
+
+Decision Making, Conflict Resolution, Role Nominations and Elections 
{#decisions}
 --------------------------------------------------------------------
 
+    
-------------------------------------------------------------------------------------
+    ISSUES TO BE ADDRESSED LATER:
+    - Add a pre-amble explaining the different decision making mechanisms and 
when they 
+      apply
+    - Add a section about review and commit, which is the primary means of 
making 
+      code related decisions
+    
-------------------------------------------------------------------------------------
+
 ### Consensus Decision Making
 
+    
-------------------------------------------------------------------------------------
+    ISSUES TO BE ADDRESSED LATER:
+    - The "Consensus Decision Making" section is totally wrong. It does not 
describe 
+      "Lazy Consensus"
+    
-------------------------------------------------------------------------------------
+
 Sub-projects or teams hosted on Xenproject.org are normally auto-governing and 
 driven by the people who volunteer for the job. This functions well for most 
 cases. When more formal decision making and coordination is required, 
decisions 
 are taken with a lazy consensus approach: a few positive votes with no 
negative 
 vote are enough to get going.
 
+    
-------------------------------------------------------------------------------------
+    - Introduce -2 to +2 voting under a new section
+    
-------------------------------------------------------------------------------------
+
 Voting is done with numbers:
 
 -   +1 : a positive vote
@@ -173,6 +230,13 @@ be addressed.
 
 ### Conflict Resolution
 
+    
-------------------------------------------------------------------------------------
+    ISSUES TO BE ADDRESSED LATER: 
+    - Generalise refereeing in terms of Project Leadership instead of specific 
roles
+    - Also some examples for sPecific situations that have happened in the 
past may be 
+      useful
+    
-------------------------------------------------------------------------------------
+
 #### Refereeing
 
 Sub-projects and teams hosted on Xenproject.org are not democracies but 
@@ -196,6 +260,11 @@ mature projects will hold a private majority vote. If the 
vote is tied, the
 [Xen Project Advisory Board](/join.html) will break the tie through a casting 
 vote.
 
+    
-------------------------------------------------------------------------------------
+    Changed headline structure: h2 to h3
+    Removed Formal Votes from headline as it has been moved into a separate 
section
+    
-------------------------------------------------------------------------------------
+
 ### Elections
 
 #### Maintainer Elections
@@ -246,12 +315,23 @@ above.
 Formal Votes {#formal-votes}
 ------------
 
+    
-------------------------------------------------------------------------------------
+    ISSUES TO BE ADDRESSED LATER: 
+    - Local votes should be handled elsewhere: this section should only cover 
global
+      decision making
+    - Better specify scope : when are Formal Votes applicable
+    - In fact we do not have any clear rules for tallying votes (do votes have 
to be 
+      unanimous or not)
+    - Note that the voting eligibility is maintainers? Do we want to retain 
this? 
+      I assume NO, as in practive we never did this.
+    
-------------------------------------------------------------------------------------
+
 Sometimes it is necessary to conduct formal voting within the community 
 (outside of elections). Formal votes are necessary when processes and 
 procedures are introduced or changed, or as part of the [Project 
 Governance](#project-governance). Who is eligible to vote, depends on whether 
 the scope of a process or procedure is **local** to a sub-project or team, or 
-whether it affects **all sub-projects** (or in other words, is **global**). 
+whether it affects **all sub-projects** (or in other words, is** global**). 
 Examples of local scope is the [Security Policy](/security-policy.html) which 
 applies to the [Hypervisor Project](/developers/teams/hypervisor.html) only. 
 Examples of global scope are changes to this document or votes outlined in the 
@@ -280,6 +360,11 @@ private vote. Public review and voting should be open for 
a minimum of a week
 each. For voting a traceable poll mechanism (e.g. voting form that keeps 
 auditable and tamper proof records) must be used. Voting follows the 
 conventions as laid out in "Principle: Consensus Decision Making".
+    
+    
-------------------------------------------------------------------------------------
+    ISSUES TO BE ADDRESSED LATER: 
+    - Verify terminology in light of changes above
+    
-------------------------------------------------------------------------------------
 
 Project Governance  {#project-governance}
 ------------------
-- 
2.5.4 (Apple Git-61)


_______________________________________________
Xen-api mailing list
Xen-api@xxxxxxxxxxxxx
https://lists.xen.org/cgi-bin/mailman/listinfo/xen-api