Re: [hibernate-dev] Hibernate Commons project
Hi,
Some thoughts:
== Group Id ==
Should be something like "org.hibernate.common" as per our discussions
from last week.
== Repo organization ==
I would prefer to have the AsciiDoc style, shared testing utilities
and other utilities in separate repos, not a shared one. To me, a repo
represents a coherent unit of "things" with its own lifecycle. Updates
to the style should not mandate an update of the version of the
testing and other utilities, so they should be in their own repo. This
should also make it easier in terms of licenses (no need for
relicensing).
== Unified Appearance ==
Now that's one field where we really should strive for consistency:
the different projects of the Hibernate umbrella should have one
shared doc style for the sake of unified and professional experience.
That's much more important than aligning on build profile names and
the like.
I don't have a strong opinion on which style it should be; the only
thing I really dislike about the current ORM one is that there is no
TOC on the side as we have it for HV. That makes it very impractical
to navigate.
--Gunnar
2017-01-30 20:57 GMT+01:00 Guillaume Smet <guillaume.smet(a)gmail.com>:
On Mon, Jan 30, 2017 at 5:36 PM, Steve Ebersole
<steve(a)hibernate.org> wrote:
> Disclaimer : I have not yet looked at the Asciidoc style. Again I promise
> to look at it when I come back from PTO. That said I want to make certain
> that the developed style matches the new ORM documentation style. The
> design team at Red Hat spent a lot of time helping us develop that.
> Specifically I mean the banners and general color scheme
>
So that you don't waste your time looking for the differences: they are not
similar.
There were a lot of things disturbing me in the current ORM theme (the
black banner too aggressive, the lots of fonts loaded, the old icons for
warning/note, some overriding that I don't find strictly necessary and
don't think are worth maintaining...). The one I put there is simpler and
doesn't override that many things (apart from adding the logo with the
banner).
That being said, it's possible to use part of what I pushed and have
specific parts for what you want to keep. It was designed that way.
Typically, I think you might be interested by the PDF theme anyway.
If others think the ORM theme should be the one we enforce, I'll push it
but I won't maintain the theme if it breaks in the future (and I'm really
not convinced by the output).
All in all, not a subject to work on while you're on PTO :).
--
Guillaume
_______________________________________________
hibernate-dev mailing list
hibernate-dev(a)lists.jboss.org
https://lists.jboss.org/mailman/listinfo/hibernate-dev