Author: cziegeler
Date: Tue Mar 3 15:25:32 2020
New Revision: 1874733
URL: http://svn.apache.org/viewvc?rev=1874733&view=rev
Log:
Clean up documentation
Removed:
felix/site/trunk/content/documentation/community/contributing-source-code.mdtext
felix/site/trunk/content/documentation/community/felix-r4-contributions.mdtext
felix/site/trunk/content/documentation/development/committers.mdtext
felix/site/trunk/content/documentation/development/integrating-felix-with-eclipse.mdtext
felix/site/trunk/content/documentation/development/integrating-felix-with-netbeans.mdtext
felix/site/trunk/content/documentation/development/project-management-committee-pmc.mdtext
felix/site/trunk/content/documentation/subprojects/apache-felix-framework/apache-felix-framework-and-alternative-java-vms.mdtext
felix/site/trunk/content/documentation/subprojects/apache-felix-framework/apache-felix-framework-and-google-android.mdtext
felix/site/trunk/content/documentation/subprojects/apache-felix-framework/apache-felix-framework-osgi-r4-2-ct-results.mdtext
felix/site/trunk/content/documentation/subprojects/apache-felix-framework/apache-felix-framework-osgi-r4-3-ct-results.mdtext
felix/site/trunk/content/documentation/tutorials-examples-and-presentations/checking-out-and-building-felix-with-netbeans.mdtext
Modified:
felix/site/trunk/content/.htaccess
felix/site/trunk/content/documentation/community/apache-felix-community-roles-and-processes.mdtext
felix/site/trunk/content/documentation/community/contributing.mdtext
felix/site/trunk/content/documentation/community/projects-using-felix.mdtext
Modified: felix/site/trunk/content/.htaccess
URL:
http://svn.apache.org/viewvc/felix/site/trunk/content/.htaccess?rev=1874733&r1=1874732&r2=1874733&view=diff
==============================================================================
--- felix/site/trunk/content/.htaccess (original)
+++ felix/site/trunk/content/.htaccess Tue Mar 3 15:25:32 2020
@@ -1,2 +1,5 @@
ErrorDocument 403 /errors/403.html
ErrorDocument 404 /errors/404.html
+Redirect Permanent /documentation/development/committers.html
/documentation/community/apache-felix-community-roles-and-processes.html
+Redirect Permanent
/documentation/development/project-management-committee-pmc.html
/documentation/community/apache-felix-community-roles-and-processes.html
+Redirect Permanent /documentation/community/contributing-source-code.html
/documentation/community/contributing.html
Modified:
felix/site/trunk/content/documentation/community/apache-felix-community-roles-and-processes.mdtext
URL:
http://svn.apache.org/viewvc/felix/site/trunk/content/documentation/community/apache-felix-community-roles-and-processes.mdtext?rev=1874733&r1=1874732&r2=1874733&view=diff
==============================================================================
---
felix/site/trunk/content/documentation/community/apache-felix-community-roles-and-processes.mdtext
(original)
+++
felix/site/trunk/content/documentation/community/apache-felix-community-roles-and-processes.mdtext
Tue Mar 3 15:25:32 2020
@@ -1,43 +1,53 @@
Title: Apache Felix Community Roles and Processes
-# Roles
+## Committers and Project Management Committee (PMC)
+
+See Apache Phone Book: [Apache Felix Committers and PMC
members](https://people.apache.org/phonebook.html?pmc=felix)
+
+### Past members:
+
+* Niclas Hedhman (stepped down 1/26/2009)
+* Trustin Lee (stepped down 2/9/2008)
+* Upayavira (stepped down 9/11/2007)
+
+## Roles
There are different roles with which Felix community members may be
associated, these roles are: users, contributors, committers, and Project
Management Committee (PMC) members. These roles are assigned and assumed based
on merit. Everyone in the Felix community can participate to whatever level
they desire, but participating and the resulting merit gained is directly
linked to the role an individual may obtain.
-## Users
+### Users
Users are the people who use any of the products of the Felix project. People
in this role are not contributing code, but they are using the products,
reporting bugs, making feature requests, testing code, and such. This is by far
the most important category of people, since without users there is no reason
for Felix. When a user starts to contribute code or documentation patches, they
become a *Contributor*.
-## Contributors
+### Contributors
Contributors are the people who write code or documentation patches or
contribute positively to the project in other ways. A volunteer's contribution
is always recognized.
-## Committers
+### Committers
Contributors who give frequent and valuable contributions to a subproject of
Felix can have their status promoted to that of a *Committer*. A Committer has
write access to Felix' source code repository.
-## PMC Members
+### PMC Members
Committers who frequently participate with valuable contributions may have
their status promoted to that of a *PMC member*. This committee is the official
managing body of project and is responsible for setting its overall direction.
-# Processes
+## Processes
-## Becoming a User or Contributor
+### Becoming a User or Contributor
There is no requirement for becoming a User or Contributor; these roles are
open to everyone.
-## Becoming a Committer
+### Becoming a Committer
In order for a Contributor to become a Committer, another Committer can
nominate that Contributor to the PMC. Once a Contributor is nominated, the PMC
will call a vote on the PMC mailing list and if there are at least 3 positive
votes and no negative votes after three days, then the Contributor is accepted
as a Committer. The Contributor should not be consulted about his/her desire to
become a Committer before the vote or be informed that they are being
considered, since this could create hard feelings if the vote does not pass.
Upon a positive vote result, the Contributor will be emailed by the PMC to
invite him/her to become a Committer. If the invitation is accepted, an
announcement about the new Committer is made to the developer mailing list and
he/she is given write access to the source code repository. A Contributor will
not officially become a Committer until the appropriate legal paperwork is
submitted.
-## Becoming a PMC Member
+### Becoming a PMC Member
In order to become a PMC member, another PMC member must nominate the
Committer. Once the Committer is nominated, the PMC will call a vote on the PMC
mailing list and if there are at least 3 positive votes and no negative votes
after three days, then the Committer is accepted as a PMC member. The Committer
should not be consulted about his/her desire to become a PMC member before the
vote or be informed that they are being considered, since this could create
hard feelings if the vote does not pass.
Upon a positive vote result, the Committer will be emailed by the PMC to
invite him/her to become a PMC member. If the invitation is accepted, an
announcement about the new PMC member is made to the developer mailing list.
-### Exceptions
+#### Exceptions
It is not strictly necessary to be a Committer first in order to become a PMC
member. In some cases, the PMC may feel that an individual may offer needed
management expertise to the project. Such individuals can be nominated by PMC
members. Any such newly accepted PMC members will also be given Committer
status.
Modified: felix/site/trunk/content/documentation/community/contributing.mdtext
URL:
http://svn.apache.org/viewvc/felix/site/trunk/content/documentation/community/contributing.mdtext?rev=1874733&r1=1874732&r2=1874733&view=diff
==============================================================================
--- felix/site/trunk/content/documentation/community/contributing.mdtext
(original)
+++ felix/site/trunk/content/documentation/community/contributing.mdtext Tue
Mar 3 15:25:32 2020
@@ -2,17 +2,42 @@ Title: Contributing
Apache Felix is a volunteer effort, so there is always plenty of work that
needs to be accomplished. If you want to help support Felix, this page is
intended as a starting point for specific contribution ideas. To further
understand how the Felix community operates, refer to the [Community Roles and
Processes]({{ refs.apache-felix-community-roles-and-processes.path }}) document
and/or join the [mailing lists|mailinglists].
-The Felix project organizes its "to do" list using the
[JIRA](http://issues.apache.org/jira/browse/Felix) issue tracking system.
Specific items from Felix' JIRA issue tracking system are highlighted on this
page, but are not limited to it. The purpose of the list here is to highlight
issues that are either more important or serve as good entry points for new
contributors.
+The Felix project organizes its "to do" list using the
[JIRA](https://issues.apache.org/jira/browse/Felix) issue tracking system.
Specific items from Felix' JIRA issue tracking system are highlighted on this
page, but are not limited to it. The purpose of the list here is to highlight
issues that are either more important or serve as good entry points for new
contributors.
It is important to point out that you do not need to be a programmer to
contribute to Felix. As such, we will break out the list of issues below for
non-programmers and programmers.
## Non-Programmers
-* Improve web site or documentation (e.g., create/propose FAQ entries). There
is no specific JIRA issue for this task, but any contributions could be posted
as new JIRA issues for the
[Documentation](http://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&mode=hide&pid=12310100&sorter/order=DESC&sorter/field=priority&resolution=-1&component=12312255)
component.
-* Define a compatibility documentation legend for bundle subprojects.
[FELIX-537](http://issues.apache.org/jira/browse/FELIX-537)
+* Improve web site or documentation (e.g., create/propose FAQ entries). There
is no specific JIRA issue for this task, but any contributions could be posted
as new JIRA issues for the Documentation component.
## Programmers
-* Write tests for the framework and/or its sub-projects, either using JUnit or
the new [BND testing
harness](http://felix.apache.org/site/bnd-testing-harness.html)
-* Work on an installer that can install Felix as a daemon/service. [Installer
issues](https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&mode=hide&pid=12310100&sorter/order=DESC&sorter/field=priority&resolution=-1&component=12310803)
-* Browse issues in [JIRA](http://issues.apache.org/jira/browse/Felix) and
submit a patch.
+Before contributing, make sure to be subscribed to the [developer mailing
list|mailinglists]. If you don't have your own issue to scratch, you can browse
open issues in [JIRA](https://issues.apache.org/jira/browse/Felix) and submit a
patch.
+
+Source code contributions fall into two categories: pull requests or grants.
This document describes both and how to handle each.
+
+### Pull Requests
+
+A pull request is a small change to existing code, typically in response to a
bug fix or improvement. If you have created a change, you should:
+
+1. Create a [JIRA](https://issues.apache.org/jira/browse/Felix) issue (or find
a pertinent existing issue) describing the issue needing to be addressed.
+1. Create a pull requests against the git repository containing the code.
+1. The pull request will eventually be reviewed and applied (if accepted) by a
Felix committer, but feel free to bug us \[nicely\]({{ refs.nicely.path }}) if
you get impatient.
+
+Providing pull requests is a very good way to become a committer at Felix,
since we'd rather have you review and apply the patches than us. :-)
+
+### Grants
+
+A grant involves donating a larger chunk of code developed elsewhere. The line
dividing a patch and a grant is sort of like the definition of pornography, we
know it when we see it. The steps for granting software are a little more
complicated since we need to ensure proper IP handling. For grants, you should:
+
+1. Verify that you have the authorization to donate the code.
+1. Review our [developer documentation]({{ refs.development.path }}) as well
as the general [Apache
documentation|https://www.apache.org/foundation/getinvolved.html] to determine
whether you would really like be involved with us and how we work.
+1. Assuming you're still interested, create a
[JIRA](https://issues.apache.org/jira/browse/Felix) issue describing the code
you wish to donate.
+1. Attach an archive containing the code along with an MD5 signature of the
archive to the above issue. You should remove any existing headers from the
source files and add the standard Apache header to each. Note that you keep the
rights to your code and can do anything with it you want, you will just grant
us the right to use it too.
+1. Allow the community time to discuss the contribution, after which a vote
will be called to accept the contribution.
+1. If the vote passes, then you will need to submit a [software
grant](https://www.apache.org/licenses/software-grant.txt) form.
+1. It is also a good idea to submit an
[ICLA](https://www.apache.org/licenses/icla.txt) to ease future contributions.
Depending on the company you work for, they may also want to contribute a
[CCLA|https://www.apache.org/licenses/cla-corporate.txt], although this isn't
strictly necessary from an Apache point of view, since it is your
responsibility to verify your ability to submit an ICLA.
+1. Once all of this information is received, then we will gather it and
perform [IP clearance](https://incubator.apache.org/ip-clearance/index.html).
+1. After a few days, if no red flags are raised, then we'll commit the code
and we're good to go.
+
+Granting code is also a path to committership at Felix, since we look more
highly on contributions from developers who wish to stay involved in the
continuing evolution and maintenance of the donated code.
Modified:
felix/site/trunk/content/documentation/community/projects-using-felix.mdtext
URL:
http://svn.apache.org/viewvc/felix/site/trunk/content/documentation/community/projects-using-felix.mdtext?rev=1874733&r1=1874732&r2=1874733&view=diff
==============================================================================
---
felix/site/trunk/content/documentation/community/projects-using-felix.mdtext
(original)
+++
felix/site/trunk/content/documentation/community/projects-using-felix.mdtext
Tue Mar 3 15:25:32 2020
@@ -2,10 +2,10 @@ Title: Projects Using Felix
This page highlights projects that use Apache Felix (listed alphabetically):
-* [Apache Karaf](http://karaf.apache.org) - A small, OSGi-based runtime that
provides a lightweight container into which various components and applications
can be deployed (formerly an Apache Felix subproject).
-* [Apache ServiceMix](http://servicemix.apache.org/) - an Enterprise Service
Bus (using Felix via Karaf).
-* [Apache Sling](http://incubator.apache.org/sling/) - a JCR content based web
application framework
-* [Apache Tuscany](http://incubator.apache.org/tuscany/) - an open source
implementation of [SCA|http://www.oasis-opencsa.org/].
+* [Apache Karaf](https://karaf.apache.org) - A small, OSGi-based runtime that
provides a lightweight container into which various components and applications
can be deployed (formerly an Apache Felix subproject).
+* [Apache ServiceMix](https://servicemix.apache.org/) - an Enterprise Service
Bus (using Felix via Karaf).
+* [Apache Sling](https://sling.apache.org/) - a framework for RESTful
web-applications based on an extensible content tree
+* [Apache Tuscany](https://tuscany.apache.org/) - an open source
implementation of [SCA|http://www.oasis-opencsa.org/].
* [Ascert VersaTest](http://www.ascert.com/) - enterprise system testing
platform
* [DySoWeb](http://www.requea.com/dysoweb/rq/en/archi/dysoweb) - A platform
for dynamic component deployment.
* [GlassFish](http://glassfish.dev.java.net) - JavaEE application server.
