Repository: incubator-samoa Updated Branches: refs/heads/gh-pages 99725af55 -> 3b9dbbeab
Finalize Bylaws, simplify documentation Project: http://git-wip-us.apache.org/repos/asf/incubator-samoa/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-samoa/commit/3b9dbbea Tree: http://git-wip-us.apache.org/repos/asf/incubator-samoa/tree/3b9dbbea Diff: http://git-wip-us.apache.org/repos/asf/incubator-samoa/diff/3b9dbbea Branch: refs/heads/gh-pages Commit: 3b9dbbeab27979a4bbc28963b80b4cc247f539a0 Parents: 99725af Author: Gianmarco De Francisci Morales <[email protected]> Authored: Tue Jul 21 11:57:41 2015 +0300 Committer: Gianmarco De Francisci Morales <[email protected]> Committed: Tue Jul 21 12:35:20 2015 +0300 ---------------------------------------------------------------------- bylaws.md | 101 ------------------------------------------- documentation/Bylaws.md | 19 ++++---- documentation/Home.md | 26 +++-------- 3 files changed, 16 insertions(+), 130 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/3b9dbbea/bylaws.md ---------------------------------------------------------------------- diff --git a/bylaws.md b/bylaws.md deleted file mode 100644 index 784c1eb..0000000 --- a/bylaws.md +++ /dev/null @@ -1,101 +0,0 @@ -# SAMOA Bylaws - -This document defines the bylaws under which the Apache SAMOA project operates. - -Apache SAMOA is a project of the Apache Software Foundation (ASF). The foundation holds the copyright on the code in the Apache SAMOA codebase. The foundation [FAQ](http://www.apache.org/foundation/faq.html) explains the operation and background of the foundation. - -Apache SAMOA is typical of Apache projects in that it operates under a set of principles, known collectively as the *Apache Way*. If you are new to Apache development, please refer to the [Apache Incubator](http://incubator.apache.org) for more information on how Apache projects operate. - - -## Roles and Responsibilities - -Apache projects define a set of roles with associated rights and responsibilities. These roles govern which tasks an individual may perform within the project. The roles are defined in the following sections. - -### Users: - -The most important participants in the project are people who use our software. The majority of our developers start out as users and guide their development efforts from the user's perspective. - -Users contribute to Apache projects by providing feedback to developers in the form of bug reports and feature suggestions. In addition, users participate in the Apache community by helping other users on mailing lists and user support forums. - -### Contributors: - -All of the volunteers who are contributing time, code, documentation, or resources to the SAMOA project. A contributor that makes sustained, welcome contributions to the project may be invited to become a Committer, though the exact timing of such invitations depends on many factors. - -### Committers: - -The project's Committers are responsible for the project's technical management. Committers have access to all project source repositories. Committers may cast binding votes on any technical discussion regarding SAMOA. - -Committer access is by invitation only and must be approved by lazy consensus of the active PMC members. A Committer is considered emeritus by their own declaration or by not contributing in any form to the project for over six months. An emeritus Committer may request reinstatement of commit access from the PMC. Such reinstatement is subject to lazy consensus approval of active PMC members. - -All Apache Committers are required to have a signed [Contributor License Agreement (CLA)](http://www.apache.org/licenses/icla.txt) on file with the Apache Software Foundation. There is a [Committer FAQ](http://www.apache.org/dev/committers.html) which provides more details on the requirements for Committers. - -A Committer who makes a sustained contribution to the project may be invited to become a member of the PMC. The form of contribution is not limited to code. It can also include other activities such as code review, helping out users on the mailing lists, documentation, and testing. - -### Project Management Committee (PMC): - -The PMC is responsible to the board and the ASF for the management and oversight of the Apache SAMOA codebase. The responsibilities of the PMC include: - - * Deciding what is distributed as products of the Apache SAMOA project, in particular all releases must be approved by the PMC - * Maintaining the project's shared resources, including the codebase repository, mailing lists, websites - * Speaking on behalf of the project - * Resolving license disputes regarding products of the project - * Nominating new PMC members and Committers - * Maintaining these bylaws and other guidelines of the project - -Membership of the PMC is by invitation only and must be approved by consensus of the active PMC members. A PMC member is considered "emeritus" by their own declaration or by not contributing in any form to the project for over six months. An emeritus member may request reinstatement to the PMC. Such reinstatement is subject to consensus approval of the active PMC members. - -The chair of the PMC is appointed by the ASF board. The chair is an office holder of the Apache Software Foundation (Vice President, Apache SAMOA) and has primary responsibility to the board for the management of the projects within the scope of the SAMOA PMC. The chair reports to the board quarterly on developments within the SAMOA project. - -The chair of the PMC is rotated annually. When the chair is rotated, or if the current chair of the PMC resigns, the PMC votes to recommend a new chair using [Single Transferable Vote (STV)](http://wiki.apache.org/general/BoardVoting) voting. The decision must be ratified by the ASF board. - -## Voting - -Decisions regarding the project are made by votes on the primary project development mailing list ([email protected]). Where necessary, PMC voting may take place on the private SAMOA PMC mailing list. Votes are clearly indicated by subject line starting with [VOTE]. Votes may contain multiple items for approval and these should be clearly separated. Voting is carried out by replying to the vote mail. Voting may take four flavors. - -| Vote | Meaning | -|------|---------| -| +1 | 'Yes', 'Agree', or 'the action should be performed'. | -| +0 | Neutral about the proposed action (or mildly negative but not enough so to want to block it). | -| -1 | This is a negative vote. On issues where consensus is required, this vote counts as a veto. All vetoes must contain an explanation of why the veto is appropriate. Vetoes with no explanation are void. It may also be appropriate for a -1 vote to include an alternative course of action. | - -All participants in the SAMOA project are encouraged to show their agreement with or against a particular action by voting. For technical decisions, only the votes of active Committers are binding. Non-binding votes are still useful for those with binding votes to understand the perception of an action in the wider SAMOA community. For PMC decisions, only the votes of active PMC members are binding. - -Voting can also be applied to changes already made to the SAMOA codebase. These typically take the form of a veto (-1) in reply to the commit message sent when the commit is made. Note that this should be a rare occurrence. All efforts should be made to discuss issues when they are still patches before the code is committed. - -Only active (i.e., non-emeritus) Committers and PMC members have binding votes. - -## Approvals - -These are the types of approval that can be sought. Different actions require different types of approval. - -| Approval | Requirements | -|-------------------|--------------| -| Consensus | requires all binding-vote holders to cast +1 votes and no binding -1 vetoes (consensus votes are rarely required due to the impracticality of getting all eligible voters to cast a vote). | -| 2/3 Majority | requires at least 2/3 of binding-vote holders to cast +1 votes. (2/3 majority is typically used for actions that affect the foundation of the project, e.g., adopting a new codebase to replace an existing product). | -| Lazy Consensus | requires 2 binding +1 votes and no -1 votes ('silence gives assent'). | -| Lazy Majority | requires 3 binding +1 votes and more binding +1 votes than -1 vetoes. | -| Lazy 2/3 Majority | requires at least 3 votes and twice as many +1 votes as -1 vetoes. | - -### Vetoes - -A valid, binding veto cannot be overruled. If a veto is cast, it must be accompanied by a valid reason explaining the reasons for the veto. The validity of a veto, if challenged, can be confirmed by anyone who has a binding vote. This does not necessarily signify agreement with the veto - merely that the veto is valid. - -If you disagree with a valid veto, you must lobby the person casting the veto to withdraw their veto. If a veto is not withdrawn, any action that has been vetoed must be reversed in a timely manner. - -## Actions - -This section describes the various actions which are undertaken within the project, the corresponding approval required for that action and those who have binding votes over the action. - -| Action | Description | Approval | Binding Votes | Minimum Length | Mailing List | -|--------|-------------|----------|---------------|----------------|--------------| -| Code Change | A change made to a codebase of the project and committed by a committer. This includes source code, documentation, and website content. | Lazy Consensus (with at least one +1 vote from someone who has not authored the patch). The code can be committed as soon as the required number of binding votes is reached. | Active Committers | 1 day | JIRA or GitHub pull request (with notification sent to dev@) | -| Release Plan | Defines the timetable and actions for a release. The plan also nominates a Release Manager. | Lazy Majority | Active Committers | 3 days | dev@ | -| Product Release | Accepting the official release of a product of the project. | Lazy Majority | Active PMC members | 3 days | dev@ | -| Adoption of New Codebase | Replacing the codebase for an existing, released product with an alternative codebase. If such a vote fails to gain approval, the existing code base will continue. This action also covers the creation of new sub-projects and sub-modules within the project. | Lazy 2/3 Majority | Active PMC members | 7 days | dev@ | -| New Committer | Electing a new Committer for the project. | Lazy Consensus | Active PMC members | 7 days | private@ | -| New PMC Member | Promoting a Committer to the PMC of the project. | Consensus | Active PMC members | 7 days | private@ | -| Emeritus PMC Member re-instatement | When an emeritus PMC member requests to be re-instated as an active PMC member. | Consensus | Active PMC members | 7 days | private@ | -| Emeritus Committer re-instatement | When an emeritus Committer requests to be re-instated as an active committer. | Consensus | Active PMC members | 7 days | private@ | -| Committer Removal | When removal of commit privileges is sought. Note: Such actions will also be referred to the ASF board by the PMC chair. | Consensus | Active PMC members (excluding the committer in question if member of the PMC) | 7 Days | private@ | -| PMC Member Removal | When removal of a PMC member is sought. Note: Such actions will also be referred to the ASF board by the PMC chair. | Consensus | Active PMC members (excluding the member in question) | 7 Days | private@ | -| Modifying Bylaws | Modifying this document. | 2/3 Majority | Active PMC members | 7 Days | dev@ | http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/3b9dbbea/documentation/Bylaws.md ---------------------------------------------------------------------- diff --git a/documentation/Bylaws.md b/documentation/Bylaws.md index 6a9005f..dafc3f8 100644 --- a/documentation/Bylaws.md +++ b/documentation/Bylaws.md @@ -3,7 +3,7 @@ title: Apache SAMOA Bylaws layout: documentation documentation: true --- -# SAMOA Bylaws (Draft) +# SAMOA Bylaws This document defines the bylaws under which the Apache SAMOA project operates. @@ -32,22 +32,22 @@ The project's Committers are responsible for the project's technical management. Committer access is by invitation only and must be approved by lazy consensus of the active PMC members. A Committer is considered emeritus by their own declaration or by not contributing in any form to the project for over six months. An emeritus Committer may request reinstatement of commit access from the PMC. Such reinstatement is subject to lazy consensus approval of active PMC members. -All Apache Committers are required to have a signed [Contributor License Agreement (CLA)](http://www.apache.org/licenses/icla.txt) on file with the Apache Software Foundation. There is a [Committer FAQ](http://www.apache.org/dev/committers.html) which provides more details on the requirements for Committers +All Apache Committers are required to have a signed [Contributor License Agreement (CLA)](http://www.apache.org/licenses/icla.txt) on file with the Apache Software Foundation. There is a [Committer FAQ](http://www.apache.org/dev/committers.html) which provides more details on the requirements for Committers. A Committer who makes a sustained contribution to the project may be invited to become a member of the PMC. The form of contribution is not limited to code. It can also include other activities such as code review, helping out users on the mailing lists, documentation, and testing. ### Project Management Committee (PMC): -The PMC is responsible to the board and the ASF for the management and oversight of the Apache SAMOA codebase. The responsibilities of the PMC include +The PMC is responsible to the board and the ASF for the management and oversight of the Apache SAMOA codebase. The responsibilities of the PMC include: - * Deciding what is distributed as products of the Apache SAMOA project. In particular all releases must be approved by the PMC. - * Maintaining the project's shared resources, including the codebase repository, mailing lists, websites. - * Speaking on behalf of the project. - * Resolving license disputes regarding products of the project. - * Nominating new PMC members and Committers. + * Deciding what is distributed as products of the Apache SAMOA project, in particular all releases must be approved by the PMC; + * Maintaining the project's shared resources, including the codebase repository, mailing lists, websites; + * Speaking on behalf of the project; + * Resolving license disputes regarding products of the project; + * Nominating new PMC members and Committers; * Maintaining these bylaws and other guidelines of the project. -Membership of the PMC is by invitation only and must be approved by consensus approval of the active PMC members. A PMC member is considered "emeritus" by their own declaration or by not contributing in any form to the project for over six months. An emeritus member may request reinstatement to the PMC. Such reinstatement is subject to consensus approval of the active PMC members. +Membership of the PMC is by invitation only and must be approved by consensus of the active PMC members. A PMC member is considered "emeritus" by their own declaration or by not contributing in any form to the project for over six months. An emeritus member may request reinstatement to the PMC. Such reinstatement is subject to consensus approval of the active PMC members. The chair of the PMC is appointed by the ASF board. The chair is an office holder of the Apache Software Foundation (Vice President, Apache SAMOA) and has primary responsibility to the board for the management of the projects within the scope of the SAMOA PMC. The chair reports to the board quarterly on developments within the SAMOA project. @@ -104,4 +104,3 @@ This section describes the various actions which are undertaken within the proje | Committer Removal | When removal of commit privileges is sought. Note: Such actions will also be referred to the ASF board by the PMC chair. | Consensus | Active PMC members (excluding the committer in question if member of the PMC) | 7 Days | private@ | | PMC Member Removal | When removal of a PMC member is sought. Note: Such actions will also be referred to the ASF board by the PMC chair. | Consensus | Active PMC members (excluding the member in question) | 7 Days | private@ | | Modifying Bylaws | Modifying this document. | 2/3 Majority | Active PMC members | 7 Days | dev@ | - http://git-wip-us.apache.org/repos/asf/incubator-samoa/blob/3b9dbbea/documentation/Home.md ---------------------------------------------------------------------- diff --git a/documentation/Home.md b/documentation/Home.md index ebc3475..5a880d5 100644 --- a/documentation/Home.md +++ b/documentation/Home.md @@ -3,17 +3,17 @@ title: Apache SAMOA Documentation layout: documentation documentation: true --- -Apache SAMOA is a distributed realtime machine learning system, similar to Mahout, but specific designed for stream mining. Apache SAMOA is simple and fun to use! +Apache SAMOA is a platform for mining big data streams. -This documentation is intended to give an introduction on how to use Apache SAMOA in different ways. As a user you can run Apache SAMOA algorithms into several Stream Processing Engines: local mode, Apache Storm, S4 and Samza. As a developer you can create new algorithms only once and test them in all of these Stream Processing Engines. +It provides a collection of distributed streaming algorithms for the most common data mining and machine learning tasks such as classification, clustering, and regression, as well as programming abstractions to develop new algorithms that run on top of distributed stream processing engines (DSPEs). It features a pluggable architecture that allows it to run on several DSPEs such as Apache Storm, Apache S4, Apache Samza, and Apache Flink. +SAMOA is similar to Mahout in spirit, but specific designed for stream mining. -## Getting Started +Apache SAMOA is simple and fun to use! This documentation is intended to give an introduction on how to use SAMOA in different ways. As a user you can run SAMOA algorithms on several stream processing engines: local mode, Storm, S4, Samza, and Flink. As a developer you can create new algorithms only once and test them in all of these distributed stream processing engines. +## Getting Started * [0 Hands-on with SAMOA: Getting Started!](Getting-Started.html) - ## Users - * [1 Building and Executing SAMOA](Scalable-Advanced-Massive-Online-Analysis.html) * [1.0 Building SAMOA](Building-SAMOA.html) * [1.1 Executing SAMOA with Apache Storm](Executing-SAMOA-with-Apache-Storm.html) @@ -29,7 +29,6 @@ This documentation is intended to give an introduction on how to use Apache SAMO * [2.7 SAMOA for MOA users](SAMOA-for-MOA-users.html) ## Developers - * [3 Understanding SAMOA Topologies](SAMOA-Topology.html) * [3.1 Processor](Processor.html) * [3.2 Content Event](Content-Event.html) @@ -41,17 +40,6 @@ This documentation is intended to give an introduction on how to use Apache SAMO * [4 Developing New Tasks in SAMOA](Developing-New-Tasks-in-SAMOA.html) ### Getting help +Discussion about SAMOA happens on the Apache development mailing list [[email protected]](mailto:[email protected]) -#### Apache SAMOA Users -Samoa users should send messages and subscribe to [[email protected]](mailto:[email protected]). - -You can subscribe to this list by sending an email to [[email protected]](mailto:[email protected]). Likewise, you can cancel a subscription by sending an email to [[email protected]](mailto:[email protected]). - - -#### Apache SAMOA Developers -Storm developers should send messages and subscribe to [[email protected]](mailto:[email protected]). - -You can subscribe to this list by sending an email to [[email protected]](mailto:[email protected]). Likewise, you can cancel a subscription by sending an email to [[email protected]](mailto:[email protected]). - -__NOTE:__ The google groups account [email protected] is now officially deprecated in favor of the Apache-hosted user/dev mailing lists. - +[ [subscribe](mailto:[email protected]) | [unsubscribe](mailto:[email protected]) | [archives](http://mail-archives.apache.org/mod_mbox/incubator-samoa-dev) ]
