incubator-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Apache Wiki <wikidi...@apache.org>
Subject [Incubator Wiki] Update of "AnnotatorProposal" by bigbluehat
Date Wed, 01 Jun 2016 13:19:28 GMT
Dear Wiki user,

You have subscribed to a wiki page or wiki category on "Incubator Wiki" for change notification.

The "AnnotatorProposal" page has been changed by bigbluehat:
https://wiki.apache.org/incubator/AnnotatorProposal?action=diff&rev1=1&rev2=2

Comment:
Remove section descriptions to improve legibility

  = Apache Annotator (proposal) =
  
  === Abstract ===
-   A short descriptive summary of the project. A short paragraph, ideally one sentence in
length.
  
  Annotation enabling code for browsers, servers, and humans.
  
  === Proposal ===
-   A lengthier description of the proposal.
  
  The Annotator community seeks to build a foundational set of libraries under a liberal license
providing the pieces necessary for developers to add annotation to their projects.
  
  === Background ===
-   Provides context for those unfamiliar with the problem space and history.
  
  Annotator.js was originally created by Open Knowledge (formerly The Open Knowledge Foundation)
to provide annotation over works by Shakespeare. Since that time, Annotator has found its
way into a wide range of browser-based annotation systems such as Hypothes.is, LacunaStories.com,
and various academic, publishing, and scientific research projects.
  
@@ -22, +19 @@

  However, the community remains interested in combined collaboration and interested in a
foundational future for annotation--both in browsers as well as servers and desktop/mobile
applications.
  
  === Rationale ===
- 
-   Explains why this project needs to exist and why should it be adopted by Apache.
  
  Annotation is often implemented in projects in ad hoc ways with developers often re-solving
problems well known to the Annotator community. The Annotator community works to provide knowledge
and code to help developers more quickly implement or improve annotation within their projects.
  
@@ -43, +38 @@

  === Current Status ===
  
  ==== Meritocracy ====
-   Apache is a meritocracy.
  
  The project is in transition from a primarily BDFL-based model to one with a more diverse
set of committers. There are 36 total known commiters to Annotator. 3 commiters having done
the bulk of the coding and decision making. 2 of those commiters acting as project leadership.
  
@@ -52, +46 @@

  We intend to invite and include participants from a wide array of annotation problem spaces
to collaborate in this new shared space.
  
  ==== Community ====
-   Apache is interested only in communities. 
  
  Community calls had been being done every 3-6 months with reports of the calls outcome being
posted to the mailing list and the annotatorjs.org website.
  
@@ -61, +54 @@

  There are many Annotator and W3C Annotation Data Model related projects found on GitHub.
Our objective would be to invite these communities to join this collaborative community with
the hope of greater stability and community longevity.
  
  ==== Core Developers ====
-   Apache is composed of individuals.
  
  The 3 primary committers to the project are Nick Stenning of The Hypothesis Project, Randall
Leeds of Medal, and Aron Carroll of Dropbox, Inc. Nick Stenning is the original creator of
Annotator. Randall Leeds is an Apache CouchDB committer. Aron has been a frequent contributor.
All three have been members of The Hypothes.is Project in past years.
  
@@ -81, +73 @@

  https://github.com/openannotation/annotator/graphs/contributors
  
  ==== Alignment ====
-   Describe why Apache is a good match for the proposal.
  
  The Annotator community believes that the Apache Software Foundation promotes and enforces
the sort of community that will best serve the future of the project. It is also believed
that Annotator can serve the ASF by providing its tools to bring annotation into various Apache
projects and eventually to the apache.org site, project documentation, and other tools within
the ASF.
  
  The priority is on increasing community involvement, defining--via the Apache Way--how we
will code and collaborate going forward, and upon creating the best possible annotation solution
born out of that collaboration.
  
  === Known Risks ===
-   An exercise in self-knowledge. Risks don't mean that a project is unacceptable. If they
are recognized and noted then they can be addressed during incubation.
  
  ==== Orphaned products ====
-   A public commitment to future development.
  
  The majority of the core committers were formerly from The Hypothes.is Project which used
an earlier version of Annotator within it's annotation web service and BSD-licensed `h` annotation
software. However, Hypothesis and most other organizations and projects using Annotator have
forked the main code base or created unique plugins which only exist within their projects
and have not been contributed upstream.
  
@@ -109, +98 @@

  Each of the core committers have worked on and created open source software for themselves
or various organizations for the greater than 5 years. Two of the contributors mentioned above
also have greater than 5 years contributor experience at the ASF and are both now core committers
to a top-level project (Apache CouchDB).
  
  ==== Homogeneous Developers ====
-   Healthy projects need a mix of developers. Open development requires a commitment to encouraging
a diverse mixture. This includes the art of working as part of a geographically scattered
group in a distributed environment.
  
  Active community members as well as plugin and compatible annotation storage system builders
are from a diverse, though scattered, range of organizations and individually driven projects.
  
@@ -120, +108 @@

  Additionally, the wide range of annotation related projects that may be considered as input
for this projects code explorations range in size, contributor diversity, and growth.
  
  ==== Reliance on Salaried Developers ====
-   A project dominated by salaried developers who are interested in the code only whilst
they are employed to do so risks its long term health.
  
  In the past, contributors to Annotator project were solely from The Hypothes.is Project
and their activity was driven primarily by the needs of that project. However, the diversity
of interested participants has greatly increased. There is an additional hope of creating
an aggregated community from various projects (including Annotator, Hypothesis' `h` code,
and various related libraries and plugins) as well as exploring the creation of new tools--not
only for the browser--to further widen the interest and activity around annotation.
  
  ==== Relationships with Other Apache Projects ====
-   Apache projects should be open to collaboration with other open source projects both within
Apache and without. Candidates should be willing to reach outside their own little bubbles.
  
  The Annotator community also provides an annotation storage system ("annotator-store") built
upon ElasticSearch. There are compatible implementations of that API built on various storage
systems (including Apache CouchDB), and the community would encourage the creation of other
compatible storage systems built upon other Apache storage projects.
  
@@ -138, +124 @@

  Lastly, Apache UIMA can currently generates Open Annotation Data Model annotations as an
output of it's Natural Language Processing system. These annotations could be displayed via
code written within this new Apache project--which could further leverage user interaction
with those NLP-based annotation (such as confirmation, rejection, or modification of the annotations
made by Apache UIMA's NLP process). There are other NLP projects within the ASF which could
similarly benefit from these explorations and code generated here.
  
  ==== A Excessive Fascination with the Apache Brand ====
-   Concerns have been raised in the past that some projects appear to have been proposed
just to generate positive publicity for the proposers. This is the right place to convince
everyone that is not the case.
  
  The Annotator community acknowledges the value and recognition that the Apache brand would
bring to the Annotator project. However, the primary interest is in the community building
process and long-term stability that the Apache Software Foundation provides for its projects.
  
@@ -147, +132 @@

  Integrating those developers into this new community and adding them as contributors is
seen as a much higher priority then increasing awareness through branding.
  
  === Documentation ===
-   References to further reading material.
  
  Websites:
   * http://annotatorjs.org/
@@ -175, +159 @@

   * http://annotatorjs.org/plugins/index.html
  
  === Initial Source ===
-   Describes the origin of the proposed code base. If the initial code arrives from more
than one source, this is the right place to outline the different histories.
  
  The original Annotator code base was created by Nick Stenning while at the Open Knowledge
Foundation. The code has been in development since before 2011 with the first public release
(v0.0.1) happening on January 1st, 2011 on GitHub.
  
@@ -184, +167 @@

  Additionally, there is a growing list of forks, plugins, and related tooling created by
the community in various places--often embedded within larger projects. The Annotator Plugins
index has reference to some such possible inputs to this project's code. The W3C specifications
are also being implemented and the growing number of projects available around those specifications
would also be considered as possible inputs. Most specifically, Randal Leeds (also a contributor
to Annotator) has built a set of libraries focus on implementing the W3C selectors. These
libraries could serve as an initial foundation for a core library for browsers or JavaScript-base
server code.
  
  === Source and Intellectual Property Submission Plan ===
-   Complex proposals (typically involving multiple code bases) may find it useful to draw
up an initial plan for the submission of the code here. Demonstrate that the proposal is practical.
  
  Our primary goal is to aggregate communities that center around annotation. We intend to
focus our initial work on a JavaScript-based library built from Randall Leeds `dom-anchor-*`
libraries (single owner copyright; MIT licensed) and potentially reusing code from Annotator
(mixed owner copyright; MIT & GPL dual-licensed).
  
@@ -297, +279 @@

  TBD
  
  ==== Sponsoring Entity ====
-   The Sponsor is the organizational unit within Apache taking responsibility for this proposal.
The sponsoring entity can be: the Apache Board, the Incubator, another Apache project
  
  The Incubator
  

---------------------------------------------------------------------
To unsubscribe, e-mail: cvs-unsubscribe@incubator.apache.org
For additional commands, e-mail: cvs-help@incubator.apache.org


Mime
View raw message