[windup-dev] Namespaces and URLs

[Sande Gilda]

Hi Marek,



On 05/26/2015 06:46 AM, Marek Novotny wrote:
> On 25.5.2015 19:18, Ondrej Zizka wrote:
>> Hi,
>>
>> the namespaces, filenames and URLs need to be informative and "scale" in
>> the future.
>>
>> 1) It needs to say windup, so people know what namespace they are
>> dealing with.
Agreed.
>>
>> 2) Same goes for the filename - when people download it. Therefore,
>> rule-schema-1.0.xsd is not good IMO.
Agreed.
>>
>> 3) I suggest to align the XSD version with the Windup core version,
>> since the XSD describes what the core accepts.
>>       "1.0" is not fortunate, as people will confuse it with legacy Windup.
>>       The version string should be the same as Windup version, so we can
>> automate things. Different formats are source of human errors.
I went with _1_0.xsd to follow the patterns JBoss uses. If you look in 
http://www.jboss.org/schema/jbossas/, you'll see none of the JBoss 
related schemas use the JBoss EAP release number. For example:

http://www.jboss.org/schema/jbossas/jboss-as-mail_1_1.xsd
http://www.jboss.org/schema/jbossas/jboss-as-logging_2_0.xsd
http://www.jboss.org/schema/jbossas/jboss-deployment-structure-1_2.xsd
http://www.jboss.org/schema/jbossas/jboss-ejb-client_1_2.xsd

Will the schema change with every release of Windup? I would expect it 
to be more stable than that.

Won't it be a maintenance nightmare to update the rules schema location 
in the XML for the rules for every release?
>> 4) It doesn't need to say "schema" - XSD is saying that.
Agreed.
>>
>> 5) It's not rule - it's a ruleset. Could be misleading.
>>
>> I suggest the URL for the current XSD to be:
>>       http://windup.jboss.org/schema/windup-ruleset-2.3.0.Final.xsd
Again, I'm not sure I like using the Windup release and I definitely 
don't like the 'Final'.
I'd prefer windup-ruleset_1_0.xsd or something like that.
>> And the namespace:
>>       Either the same,
>>       http://windup.jboss.org/schema/windup-ruleset-2.3.0.Final.xsd
>>       or,
>>       http://windup.jboss.org/ns/ruleset/2.3.0.Final , and that would be
>> handled by the site (e.g., redirect to docs).
> I am not really sure if it is good idea to have version in namespace
>> Sounds good?
>> Ondra
>> _______________________________________________
>> windup-dev mailing list
>> windup-dev at lists.jboss.org
>> https://lists.jboss.org/mailman/listinfo/windup-dev
>>
> I would agree with almost all, but why won't we have so long version
> string in that filename/schema?
>
> micro version identificator is imho not necessary as you should not
> change the schema in micro releases.
> So http://windup.jboss.org/schema/windup-ruleset-2_3.xsd should work
> better IMO.
>