You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@lucene.apache.org by Alexandre Rafalovitch <ar...@gmail.com> on 2014/03/07 04:42:23 UTC
Fwd: Am I allowed to generate, enhance and republish a JavaDoc of an
Apache project?
I asked this on Apache legal list but got no reply. So, I thought I'll
try again for the group it will affect directly (project not mentioned
below is Solr).
Any opinion on legality, usefulness or possibly underlying causes of
the original problem would be appreciated.
Regards,
Alex.
---------- Forwarded message ----------
Date: Thu, Feb 27, 2014 at 4:41 PM
Subject: Am I allowed to generate, enhance and republish a JavaDoc of
an Apache project?
To: legal-discuss@apache.org
Hello,
For one (of many) of the Apache projects that I use, I am very
frustrated that Google cannot find the officially-hosted Javadocs.
I am not sure why, but I think this could be an interesting area for
experimentation. So I want to do following things (as a mini-project),
in the increasing level of complexity/effort and see if that will make
discovering relevant information easier. The goal is to publish
information on the web under my own space and experiment with SEO,
Analytics, etc.
My question for all of the things below is whether any of them violate
the Apache License, Version 2.0 under which the source is published
and whether I need to propagate the license mention itself.
1) Regenerate the JavaDoc with all the multiple packages/partitions
merged together but otherwise unchanged? Current official javadocs
have license text generated, do I need to do that too?
2) Generate the JavaDoc using different options and/or custom doclets
that would enhance output with things like internal cross-links?
3) Generate the JavaDoc+JavaDoc-generated Source. This will obviously
keep the licence in the file, but are there extra issues?
4) Generate the JavaDoc also with links to external sources, possibly
using affiliate links for things like books? Basically a
commercialization of the additional curation effort (one can dream).
I know various website do republish these kinds of things. But I want
to be clear and in compliance before I start on this project, out of
several others.
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org
Re: Fwd: Am I allowed to generate, enhance and republish a JavaDoc of
an Apache project?
Posted by Alexandre Rafalovitch <ar...@gmail.com>.
Thanks Shawn, these are neat tricks.
I did find a couple of similar tricks with the versions. But I keep
forgetting them and sometimes even that does not help.
Additionally, the way Javadocs are built, the cross-links do not work
too well. The classes are split between build modules and if you want
to go up and down the inheritance hierarchy that spins multiple
modules (or Solr/Lucene divide) you do not even get told those classes
exist. So, it becomes a case of knowing that it exists to look for it.
I am not saying it is terrible, just that perhaps it can be made
better. And I want to experiment with making it better. So I need a
freedom to experiment faster than official release policy.
Regards,
Alex.
P.s. I am not a SEO expert either. Once I learn to be one with this
and/or other projects, I would be more than happy to contribute my
skills back to the official documentation.
Personal website: http://www.outerthoughts.com/
LinkedIn: http://www.linkedin.com/in/alexandrerafalovitch
- Time is the quality of nature that keeps events from happening all
at once. Lately, it doesn't seem to be working. (Anonymous - via GTD
book)
On Fri, Mar 7, 2014 at 4:32 PM, Shawn Heisey <so...@elyograg.org> wrote:
> On 3/6/2014 8:42 PM, Alexandre Rafalovitch wrote:
>> I asked this on Apache legal list but got no reply. So, I thought I'll
>> try again for the group it will affect directly (project not mentioned
>> below is Solr).
>>
>> Any opinion on legality, usefulness or possibly underlying causes of
>> the original problem would be appreciated.
>>
>> Regards,
>> Alex.
>> ---------- Forwarded message ----------
>> Date: Thu, Feb 27, 2014 at 4:41 PM
>> Subject: Am I allowed to generate, enhance and republish a JavaDoc of
>> an Apache project?
>> To: legal-discuss@apache.org
>>
>>
>> Hello,
>>
>> For one (of many) of the Apache projects that I use, I am very
>> frustrated that Google cannot find the officially-hosted Javadocs.
>
> I'm not going to try to comment about the legal issues, but I will tell
> you that I can very often find javadocs for a very specific class by
> searching for it along with a specific recent version number. So I will
> google for 'HttpSolrServer 4.7.0' and I have what I need. Finding
> related things is normally pretty easy, because there are clickable
> links for related classes buried in any given javadoc page.
>
> When searching for recent docs for SolrQuery, if I leave out the version
> number, I only get 4.2.1 and 3.6.0 near the top of the results. If I
> add a version number, the top results are actually kinda useless. A
> search for 'SolrQuery 4.6.1 API' did the trick. It's simply too common
> a phrase, especially when broken apart into Solr and Query.
>
> There are very likely things that we can do to improve our search engine
> results. I'm not well versed in SEO myself.
>
> Thanks,
> Shawn
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
> For additional commands, e-mail: dev-help@lucene.apache.org
>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org
Re: Fwd: Am I allowed to generate, enhance and republish a JavaDoc
of an Apache project?
Posted by Shawn Heisey <so...@elyograg.org>.
On 3/6/2014 8:42 PM, Alexandre Rafalovitch wrote:
> I asked this on Apache legal list but got no reply. So, I thought I'll
> try again for the group it will affect directly (project not mentioned
> below is Solr).
>
> Any opinion on legality, usefulness or possibly underlying causes of
> the original problem would be appreciated.
>
> Regards,
> Alex.
> ---------- Forwarded message ----------
> Date: Thu, Feb 27, 2014 at 4:41 PM
> Subject: Am I allowed to generate, enhance and republish a JavaDoc of
> an Apache project?
> To: legal-discuss@apache.org
>
>
> Hello,
>
> For one (of many) of the Apache projects that I use, I am very
> frustrated that Google cannot find the officially-hosted Javadocs.
I'm not going to try to comment about the legal issues, but I will tell
you that I can very often find javadocs for a very specific class by
searching for it along with a specific recent version number. So I will
google for 'HttpSolrServer 4.7.0' and I have what I need. Finding
related things is normally pretty easy, because there are clickable
links for related classes buried in any given javadoc page.
When searching for recent docs for SolrQuery, if I leave out the version
number, I only get 4.2.1 and 3.6.0 near the top of the results. If I
add a version number, the top results are actually kinda useless. A
search for 'SolrQuery 4.6.1 API' did the trick. It's simply too common
a phrase, especially when broken apart into Solr and Query.
There are very likely things that we can do to improve our search engine
results. I'm not well versed in SEO myself.
Thanks,
Shawn
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org