You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@jena.apache.org by Paolo Castagna <ca...@googlemail.com> on 2011/11/11 13:28:57 UTC
Re: svn commit: r1200786 - /incubator/jena/Jena2/README
Hi Andy,
thanks for adding a README file on the SVN repo, I think it's very useful
and helpful for orienting new users who want to look at the sources.
Indeed we could have a README (very similar to the one you wrote) on the
top level, here: http://svn.apache.org/repos/asf/incubator/jena/
Do you mind if I add a README file there too?
Part of the rational of having such file on the root level of the SVN
repo is to point users in the right direction and avoid things like this:
https://issues.apache.org/jira/browse/JENA-160
Also, as a new user/reader I would also like to see a list of the
modules/subdirectories in the file you just added:
http://svn.apache.org/repos/asf/incubator/jena/Jena2/README
Something very brief, something like this:
"""
The Jena2 modules are:
- ARQ/ the SPARQL query engine used by Jena
- Eyeball/ a tool for checking RDF models (including OWL) for common problems
- Fuseki/ a SPARQL server built using Jena, ARQ, TDB and Jetty
- IRI/ a library used by Jena for RFC 3987 (IRI) and RFC 3986 (URI)
- JenaTop/ the Jena parent pom.xml file
- LARQ/ a combination of ARQ and Lucene for running free text query via SPARQL
- SDB/ storage and query component for Jena which uses SQL databases
- TDB/ a pure Java storage and query component for Jena
- jena/ the main Jena core module for IO, RDF APIs, Ontology APIs, Inference, etc.
"""
Do you mind if I add this list to the README file after the textual description
you wrote?
I met a lot of developers here at Apache and when I tell them what Jena is
I found that it's very effective for them to see the list of modules and
I through a quick description of each module, what it does, why it's there
and I describe the relationships of these modules (i.e. Fuseki is a SPARQL
server and it uses Jena, ARQ which is the SPARQL query engine, TDB as storage
layer and Jetty as Servlet container). Very simple and quick... then they go
off and (hopefully) check it out and try it.
I also found to be very effective for developers to show how quick and easy can
be to checkout, package, load some data and run Fuseki. I did this as a demo
yesterday as well (and (fortunately) it went well... from trunk! :-)).
When you do this in less than 2 minutes with them sitting in front of a
video with you and by the time you finish to tell them what Fuseki is about
it's up and running and you show them how to run SPARQL queries with it...
you see that they appreciate the agility, simplicity and ease of use.
This is thanks to you (Andy) for Fuseki and the effort and attention you put
in keeping this as easy as possible. It's a wonderful experience for developers
to get them started (no barrier to entry here... very important for a software
project). It is often a first bad experience which puts potential users off
forever or for a long period of time. We certainly do not want that.
I strongly believe that often a first good|bad experience can be significant
for the involvement or run away of a new developer with a project.
I've experienced something similar myself recently with Clerezza (good
experience) and Stanbol (bad experience... very frustrating, I still do not
have an HelloWorld example running because of the strict requirement of an
OSGi container).
Once a new developer|user had a very good experience, they usually ask for
more good experiences and slowly they drill down deeper and deeper into the
project. I found very useful to show them little examples of how you do this
and that, etc. For this I have been collecting short examples here:
https://github.com/castagna/Apache-Jena-Examples
If we all think it's useful/helpful I'd like to move these examples to a
jena-examples module which I am prepared to support and fully maintain from
now on (and of course if you have feedback on the existing examples or
additional examples or ideas for examples I should add there... welcome!)
I am glad to take that feedback on board and translate it in Java as fast
as I can.
Where would be the best place (in SVN) to have an examples module?
If everybody agrees it's a good idea and you point me to a location and
directory name (and there is agreement on this), I do it.
Cheers,
Paolo
andy@apache.org wrote:
> Author: andy
> Date: Fri Nov 11 09:24:16 2011
> New Revision: 1200786
>
> URL: http://svn.apache.org/viewvc?rev=1200786&view=rev
> Log:
> Add a README for the top level svn repository
>
> Added:
> incubator/jena/Jena2/README
>
> Added: incubator/jena/Jena2/README
> URL: http://svn.apache.org/viewvc/incubator/jena/Jena2/README?rev=1200786&view=auto
> ==============================================================================
> --- incubator/jena/Jena2/README (added)
> +++ incubator/jena/Jena2/README Fri Nov 11 09:24:16 2011
> @@ -0,0 +1,18 @@
> +Jena README
> +===========
> +
> +Welcome to Apache Jena, a Java framework
> +for writing Semantic Web applications.
> +
> +The Jena Framework includes:
> +
> ++ an API for reading, processing and writing RDF data in XML, N-triples and Turtle formats;
> ++ an ontology API for handling OWL and RDFS ontologies;
> ++ a rule-based inference engine for reasoning with RDF and OWL data sources;
> ++ stores to allow large numbers of RDF triples to be efficiently stored on disk;
> ++ a query engine compliant with the latest SPARQL specification
> ++ servers to allow RDF data to be published to other applications using SPARQL
> +
> +The codebase for the active modules is to be found under:
> +
> +https://svn.apache.org/repos/asf/incubator/jena/Jena2/
>
>
Re: svn commit: r1200786 - /incubator/jena/Jena2/README
Posted by Paolo Castagna <ca...@googlemail.com>.
Andy Seaborne wrote:
> On 11/11/11 12:28, Paolo Castagna wrote:
>> Hi Andy,
>> thanks for adding a README file on the SVN repo, I think it's very useful
>> and helpful for orienting new users who want to look at the sources.
>>
>> Indeed we could have a README (very similar to the one you wrote) on the
>> top level, here: http://svn.apache.org/repos/asf/incubator/jena/
>>
>> Do you mind if I add a README file there too?
>
> Already done as I've said. Except web-svn isn't showing the file while
> svnthinks it's checked in. Sigh.
Really, really strange... :-/
Paolo
>
> Email earlier today:
> """
> (note to self - remove top level meaningless tags/ trunk/ branch/ and
> add a brief README)
> """
> and JENA-161 comment.
>
> Andy
Re: svn commit: r1200786 - /incubator/jena/Jena2/README
Posted by Andy Seaborne <an...@apache.org>.
On 11/11/11 12:28, Paolo Castagna wrote:
> Hi Andy,
> thanks for adding a README file on the SVN repo, I think it's very useful
> and helpful for orienting new users who want to look at the sources.
>
> Indeed we could have a README (very similar to the one you wrote) on the
> top level, here: http://svn.apache.org/repos/asf/incubator/jena/
>
> Do you mind if I add a README file there too?
Already done as I've said. Except web-svn isn't showing the file while
svnthinks it's checked in. Sigh.
Email earlier today:
"""
(note to self - remove top level meaningless tags/ trunk/ branch/ and
add a brief README)
"""
and JENA-161 comment.
Andy