Re: [hibernate-dev] [Search and more] What is new in a give release
Hey,
I pushed an update to staging. I only converted the "Search" part for now.
What changes:
- The _data folder structured changed a bit, so that we can introduces a
YAML file for each series (5.5, 5.6, 5.6, 5.8, ...), containing a summary
of this series and a list of integration constraints (ORM > 5.2, etc.)
- The "Downloads" page is renamed to "Releases", since, well, it's about
more than just downloads. See
http://staging.hibernate.org/search/releases/
- The "Releases" page now includes a "Compatibilty matrix" section based
on the new data I mentioned above
- The "Releases" page now includes links to one page for each series
("More on the 5.8 series")
- There is now one page for each series (see
http://staging.hibernate.org/search/releases/series/5.8/). This page
includes:
- A short (one-line) summary of this series
- A reminder of the integration constraints for this series
- A section about the main changes in this release. I only wrote
something for the 5.8 series for now, and I basically
copy/pasted sections
from various blog posts.
- A list of all releases in this series.
What I didn't do, but could make sense:
- add a sub-menu element under "Releases" for each series
- link to the documentation for each of the latest releases from the
"Releases" page
- link to the latest documentation and to the migration guides from each
series' page
What do you all think? Emmanuel, would this address your concerns? Steve,
would this be a good fit for ORM?
Yoann Rodière
Hibernate NoORM Team
yo...@hibernate.org
On 6 September 2017 at 17:16, Steve Ebersole wrote:
> This is something I brought up ages ago wrt ORM. I wanted something
> (although ideally integrated with the "more version friendly"
> hibernate.org design) similar to what I did atm on the ORM GitHub wiki.
> For example, for 5.2 we have:
>
>
>- https://github.com/hibernate/hibernate-orm/wiki/Roadmap5.2
>- https://github.com/hibernate/hibernate-orm/wiki/Migration-Guide---5.2
>- https://github.com/hibernate/hibernate-orm/wiki/ReleaseNotes5.2
>
>
> The format could be better and some of this information could be combined
> (release notes and migration guide e.g.). But bear in mind that this was
> just what I put together to illustrate what I was wanted to do, generally
> speaking - so its a bit "rough"
>
>
> On Wed, Sep 6, 2017 at 4:17 AM Sanne Grinovero
> wrote:
>
>> Thanks for that Emmanuel.
>>
>> I'll fix the one-liner describing the release, I believe we had
>> already noticed this in the past: they need to describe the whole
>> minor not the micro update.
>> The Search roadmap actually also needs a little re-touch, I'll propose
>> a PR for that too.
>>
>> Regarding past roadmaps: I don't like to clutter the roadmap page with
>> the previous copies, especially as they should have a different nature
>> of not being a plan but being a record of what was actually done.
>> Also, we did agree in past meetings to remove all the old ones. e.g.
>> we never ported the release notes for version 3.x and 4.x as back then
>> we decided this was no place for that. Happy to revisit this decision
>> but let's separate them:
>>
>> What about a "past releases" page at the same level of roadmap, and
>> linking to it both from the main Search menu and the roadmap?
>>
>> +1 for Yoann's proposal to re-introduce the compatibility matrix
>> (there was one ~6 years ago). I also had proposed to reintroduce it
>> more recently, and was not done on the grounds that it gets out of
>> date quickly.
>> Still users badly need it so unless someone has a better idea, let's
>> agree on trying to keep it up to date manually. Let's try structure it
>> in such a way that it won't need to be updated for every single
>> release.
>>
>> Thanks,
>> Sanne
>>
>>
>> On 6 September 2017 at 08:37, Yoann Rodiere wrote:
>> > Hey,
>> >
>> > About Search, true, the information is somewhat hidden in many blog
>> posts.
>> > I'm not sure the roadmap is the right place, though, since we probably
>> want
>> > the format to be different for past and future releases: information for
>> > past releases is typically more precise and more verbose, with code
>> > examples and so on. See for instance this blog post:
>> http://in.relation.to/
>> > 2017/06/13/hibernate-search-5-8-0-Beta3/ . I'm afraid the future
>> roadmap
>> > would be drowned in the past releases.
>> >
>> > I was thinking about another problem: we don't have a compatibility
>> matrix.
>> > We only have a few dependencies (mainly ORM and Lucene), but it's really
>> > hard to know which versions of the dependencies to use with which
>> version
>> > of Search, and users frequently use the wrong versions.
>> > With that in mind, I would rather see a "Versions" page, with a summary
>> at
>> > the top (including a one-liner for each minor and the compatibilty
>> matrix),
>> > and one section for each minor (with anchors, so that we can link
Re: [hibernate-dev] [Search and more] What is new in a give release
Thanks Yoann!
Looks great.
Two minor suggestions:
- could the two links we have for each release on search/releases/ on
two separate lines? Or something else to make it clear that there are
two linkes.
- Regarding the "Compatibility matrix", the header line (the one in
black) .. I think we need to clarify in some way that you're referring
to Hibernate Search releases. Possibly just link to the page
describing the family?
Thanks,
Sanne
On 8 September 2017 at 13:53, Yoann Rodiere wrote:
> Hey,
>
> I pushed an update to staging. I only converted the "Search" part for now.
> What changes:
>
> The _data folder structured changed a bit, so that we can introduces a YAML
> file for each series (5.5, 5.6, 5.6, 5.8, ...), containing a summary of this
> series and a list of integration constraints (ORM > 5.2, etc.)
> The "Downloads" page is renamed to "Releases", since, well, it's about more
> than just downloads. See http://staging.hibernate.org/search/releases/
> The "Releases" page now includes a "Compatibilty matrix" section based on
> the new data I mentioned above
> The "Releases" page now includes links to one page for each series ("More on
> the 5.8 series")
> There is now one page for each series (see
> http://staging.hibernate.org/search/releases/series/5.8/). This page
> includes:
>
> A short (one-line) summary of this series
> A reminder of the integration constraints for this series
> A section about the main changes in this release. I only wrote something for
> the 5.8 series for now, and I basically copy/pasted sections from various
> blog posts.
> A list of all releases in this series.
>
> What I didn't do, but could make sense:
>
> add a sub-menu element under "Releases" for each series
> link to the documentation for each of the latest releases from the
> "Releases" page
> link to the latest documentation and to the migration guides from each
> series' page
>
> What do you all think? Emmanuel, would this address your concerns? Steve,
> would this be a good fit for ORM?
>
> Yoann Rodière
> Hibernate NoORM Team
> yo...@hibernate.org
>
> On 6 September 2017 at 17:16, Steve Ebersole wrote:
>>
>> This is something I brought up ages ago wrt ORM. I wanted something
>> (although ideally integrated with the "more version friendly" hibernate.org
>> design) similar to what I did atm on the ORM GitHub wiki. For example, for
>> 5.2 we have:
>>
>> https://github.com/hibernate/hibernate-orm/wiki/Roadmap5.2
>> https://github.com/hibernate/hibernate-orm/wiki/Migration-Guide---5.2
>> https://github.com/hibernate/hibernate-orm/wiki/ReleaseNotes5.2
>>
>>
>> The format could be better and some of this information could be combined
>> (release notes and migration guide e.g.). But bear in mind that this was
>> just what I put together to illustrate what I was wanted to do, generally
>> speaking - so its a bit "rough"
>>
>>
>> On Wed, Sep 6, 2017 at 4:17 AM Sanne Grinovero
>> wrote:
>>>
>>> Thanks for that Emmanuel.
>>>
>>> I'll fix the one-liner describing the release, I believe we had
>>> already noticed this in the past: they need to describe the whole
>>> minor not the micro update.
>>> The Search roadmap actually also needs a little re-touch, I'll propose
>>> a PR for that too.
>>>
>>> Regarding past roadmaps: I don't like to clutter the roadmap page with
>>> the previous copies, especially as they should have a different nature
>>> of not being a plan but being a record of what was actually done.
>>> Also, we did agree in past meetings to remove all the old ones. e.g.
>>> we never ported the release notes for version 3.x and 4.x as back then
>>> we decided this was no place for that. Happy to revisit this decision
>>> but let's separate them:
>>>
>>> What about a "past releases" page at the same level of roadmap, and
>>> linking to it both from the main Search menu and the roadmap?
>>>
>>> +1 for Yoann's proposal to re-introduce the compatibility matrix
>>> (there was one ~6 years ago). I also had proposed to reintroduce it
>>> more recently, and was not done on the grounds that it gets out of
>>> date quickly.
>>> Still users badly need it so unless someone has a better idea, let's
>>> agree on trying to keep it up to date manually. Let's try structure it
>>> in such a way that it won't need to be updated for every single
>>> release.
>>>
>>> Thanks,
>>> Sanne
>>>
>>>
>>> On 6 September 2017 at 08:37, Yoann Rodiere wrote:
>>> > Hey,
>>> >
>>> > About Search, true, the information is somewhat hidden in many blog
>>> > posts.
>>> > I'm not sure the roadmap is the right place, though, since we probably
>>> > want
>>> > the format to be different for past and future releases: information
>>> > for
>>> > past releases is typically more precise and more verbose, with code
>>> > examples and so on. See for instance this blog post:
>>> > http://in.relation.to/
>>> > 2017/06/13/hibernate-search-5-8-0-Beta3/ . I'm afraid the future
>>> > roadmap
>>> > would be drowned in the past releases.
>>> >
>>> > I was think
Re: [hibernate-dev] [Search and more] What is new in a give release
Sanne, I addressed both your comments. Is it better?
I also addressed Guillaume's comment on HipChat, and made the compatibility
matrix a bit... fuzzier, so that we won't have to update it as often. We
can still make it very specific if we want to, but we won't be limited by
the layout anymore.
Yoann Rodière
Hibernate NoORM Team
yo...@hibernate.org
On 8 September 2017 at 15:11, Sanne Grinovero wrote:
> Thanks Yoann!
> Looks great.
>
> Two minor suggestions:
> - could the two links we have for each release on search/releases/ on
> two separate lines? Or something else to make it clear that there are
> two linkes.
> - Regarding the "Compatibility matrix", the header line (the one in
> black) .. I think we need to clarify in some way that you're referring
> to Hibernate Search releases. Possibly just link to the page
> describing the family?
>
> Thanks,
> Sanne
>
>
> On 8 September 2017 at 13:53, Yoann Rodiere wrote:
> > Hey,
> >
> > I pushed an update to staging. I only converted the "Search" part for
> now.
> > What changes:
> >
> > The _data folder structured changed a bit, so that we can introduces a
> YAML
> > file for each series (5.5, 5.6, 5.6, 5.8, ...), containing a summary of
> this
> > series and a list of integration constraints (ORM > 5.2, etc.)
> > The "Downloads" page is renamed to "Releases", since, well, it's about
> more
> > than just downloads. See http://staging.hibernate.org/search/releases/
> > The "Releases" page now includes a "Compatibilty matrix" section based on
> > the new data I mentioned above
> > The "Releases" page now includes links to one page for each series
> ("More on
> > the 5.8 series")
> > There is now one page for each series (see
> > http://staging.hibernate.org/search/releases/series/5.8/). This page
> > includes:
> >
> > A short (one-line) summary of this series
> > A reminder of the integration constraints for this series
> > A section about the main changes in this release. I only wrote something
> for
> > the 5.8 series for now, and I basically copy/pasted sections from various
> > blog posts.
> > A list of all releases in this series.
> >
> > What I didn't do, but could make sense:
> >
> > add a sub-menu element under "Releases" for each series
> > link to the documentation for each of the latest releases from the
> > "Releases" page
> > link to the latest documentation and to the migration guides from each
> > series' page
> >
> > What do you all think? Emmanuel, would this address your concerns? Steve,
> > would this be a good fit for ORM?
> >
> > Yoann Rodière
> > Hibernate NoORM Team
> > yo...@hibernate.org
> >
> > On 6 September 2017 at 17:16, Steve Ebersole
> wrote:
> >>
> >> This is something I brought up ages ago wrt ORM. I wanted something
> >> (although ideally integrated with the "more version friendly"
> hibernate.org
> >> design) similar to what I did atm on the ORM GitHub wiki. For example,
> for
> >> 5.2 we have:
> >>
> >> https://github.com/hibernate/hibernate-orm/wiki/Roadmap5.2
> >> https://github.com/hibernate/hibernate-orm/wiki/Migration-Guide---5.2
> >> https://github.com/hibernate/hibernate-orm/wiki/ReleaseNotes5.2
> >>
> >>
> >> The format could be better and some of this information could be
> combined
> >> (release notes and migration guide e.g.). But bear in mind that this
> was
> >> just what I put together to illustrate what I was wanted to do,
> generally
> >> speaking - so its a bit "rough"
> >>
> >>
> >> On Wed, Sep 6, 2017 at 4:17 AM Sanne Grinovero
> >> wrote:
> >>>
> >>> Thanks for that Emmanuel.
> >>>
> >>> I'll fix the one-liner describing the release, I believe we had
> >>> already noticed this in the past: they need to describe the whole
> >>> minor not the micro update.
> >>> The Search roadmap actually also needs a little re-touch, I'll propose
> >>> a PR for that too.
> >>>
> >>> Regarding past roadmaps: I don't like to clutter the roadmap page with
> >>> the previous copies, especially as they should have a different nature
> >>> of not being a plan but being a record of what was actually done.
> >>> Also, we did agree in past meetings to remove all the old ones. e.g.
> >>> we never ported the release notes for version 3.x and 4.x as back then
> >>> we decided this was no place for that. Happy to revisit this decision
> >>> but let's separate them:
> >>>
> >>> What about a "past releases" page at the same level of roadmap, and
> >>> linking to it both from the main Search menu and the roadmap?
> >>>
> >>> +1 for Yoann's proposal to re-introduce the compatibility matrix
> >>> (there was one ~6 years ago). I also had proposed to reintroduce it
> >>> more recently, and was not done on the grounds that it gets out of
> >>> date quickly.
> >>> Still users badly need it so unless someone has a better idea, let's
> >>> agree on trying to keep it up to date manually. Let's try structure it
> >>> in such a way that it won't need to be updated for every single
> >>> release.
> >>>
> >>> Thanks,
> >>> Sanne
> >>>
> >>>
Re: [hibernate-dev] [Search and more] What is new in a give release
For me the real problem is that its not just Downloads/Releases that should
be (need to be really) treated in this manner - our documentation is also
family specific.
So for ORM I had envisioned a "versions" (although "releases" works just as
well) component to the url scheme. Vlad did this for documentation (see
the version drop down), but we have not yet tackled this for versions - too
many other more pressing tasks. Also, I am not sure yet the best overall
structure for this - some of the project related information is not
version-specific (FAQ, Books, Paid Support, etc) while others are.
To me personally, I think the "Documentation" and
Downloads/Versions/Releases should not be on the left nav. Or, leave them
on the nav and have them implicitly direct to the
most-recent-prod-release-family. But overall I had envisioned a
release-specific page - specific to release families (5.0, 5.1, etc) as
opposed to specific micro/bugfix releases (5.0.1, 5.0.2, etc). This
release page would include:
1. General description - what were the main points or developments for
this family?
2. Links to its documentation
3. List of all micro/bugfix releases as a sort-of simplified changelog.
This part is still unclear in my head as to the best way to represent this
information, but ultimately each entry in this list would need to include:
1. announcement URL
2. sysopsis of the main fixes/changes
3. link to the full changelog
For the most part, the information I listed for the micro/bugfix release
entries is covered in the release announcement so one option is to simply
link to each announcement for that family - possibly driven by the release
yaml files.
This also fixes what I find to be a very confusing list of "latest"
releases. I think that works much better as a single entry on the release
family page.
Will what you did "work" for ORM? Sure. What I describe is just what I
personally think would be better in terms of ORM needs, but I have
absolutely no resources to do that atm. So for now, whatever y'all deem is
best is probably the best way to go.
On Fri, Sep 8, 2017 at 8:11 AM Sanne Grinovero wrote:
> Thanks Yoann!
> Looks great.
>
> Two minor suggestions:
> - could the two links we have for each release on search/releases/ on
> two separate lines? Or something else to make it clear that there are
> two linkes.
> - Regarding the "Compatibility matrix", the header line (the one in
> black) .. I think we need to clarify in some way that you're referring
> to Hibernate Search releases. Possibly just link to the page
> describing the family?
>
> Thanks,
> Sanne
>
>
> On 8 September 2017 at 13:53, Yoann Rodiere wrote:
> > Hey,
> >
> > I pushed an update to staging. I only converted the "Search" part for
> now.
> > What changes:
> >
> > The _data folder structured changed a bit, so that we can introduces a
> YAML
> > file for each series (5.5, 5.6, 5.6, 5.8, ...), containing a summary of
> this
> > series and a list of integration constraints (ORM > 5.2, etc.)
> > The "Downloads" page is renamed to "Releases", since, well, it's about
> more
> > than just downloads. See http://staging.hibernate.org/search/releases/
> > The "Releases" page now includes a "Compatibilty matrix" section based on
> > the new data I mentioned above
> > The "Releases" page now includes links to one page for each series
> ("More on
> > the 5.8 series")
> > There is now one page for each series (see
> > http://staging.hibernate.org/search/releases/series/5.8/). This page
> > includes:
> >
> > A short (one-line) summary of this series
> > A reminder of the integration constraints for this series
> > A section about the main changes in this release. I only wrote something
> for
> > the 5.8 series for now, and I basically copy/pasted sections from various
> > blog posts.
> > A list of all releases in this series.
> >
> > What I didn't do, but could make sense:
> >
> > add a sub-menu element under "Releases" for each series
> > link to the documentation for each of the latest releases from the
> > "Releases" page
> > link to the latest documentation and to the migration guides from each
> > series' page
> >
> > What do you all think? Emmanuel, would this address your concerns? Steve,
> > would this be a good fit for ORM?
> >
> > Yoann Rodière
> > Hibernate NoORM Team
> > yo...@hibernate.org
> >
> > On 6 September 2017 at 17:16, Steve Ebersole
> wrote:
> >>
> >> This is something I brought up ages ago wrt ORM. I wanted something
> >> (although ideally integrated with the "more version friendly"
> hibernate.org
> >> design) similar to what I did atm on the ORM GitHub wiki. For example,
> for
> >> 5.2 we have:
> >>
> >> https://github.com/hibernate/hibernate-orm/wiki/Roadmap5.2
> >> https://github.com/hibernate/hibernate-orm/wiki/Migration-Guide---5.2
> >> https://github.com/hibernate/hibernate-orm/wiki/ReleaseNotes5.2
> >>
> >>
> >> The format could be better and some of this information could be
>
Re: [hibernate-dev] [Search and more] What is new in a give release
Steve,
If I understood correctly, the main difference between what I did and what
you want is you don't want a "hub" pointing to different versions, you want
to redirect to the page for the latest version, and from there allow to
move to another version using drop-down.
While I can understand you'd want that for ORM, I'm not sure it's such a
good idea for projects such as Search or OGM, where the difference between
two families is not only about features, but also (and in some cases,
mainly) about which versions of other components it can integrate with. In
this case, I'm not sure a drop-down would be enough to guide users to the
correct version...
As for your other concerns:
- I'll try to add a links to the "documentation" page specific to each
series, both in the main "releases" page and in each series-specific page.
- The list of all micro/bugfix releases is already there, at the bottom
of the page: http://staging.hibernate.org/search/releases/5.8/
I'll see if I can add some sort of table of contents at the top to make
it more visible.
- The link to the full changelog is already there, though maybe it's not
very visible.
Yoann Rodière
Hibernate NoORM Team
yo...@hibernate.org
On 8 September 2017 at 16:05, Steve Ebersole wrote:
> For me the real problem is that its not just Downloads/Releases that
> should be (need to be really) treated in this manner - our documentation is
> also family specific.
>
> So for ORM I had envisioned a "versions" (although "releases" works just
> as well) component to the url scheme. Vlad did this for documentation (see
> the version drop down), but we have not yet tackled this for versions - too
> many other more pressing tasks. Also, I am not sure yet the best overall
> structure for this - some of the project related information is not
> version-specific (FAQ, Books, Paid Support, etc) while others are.
>
> To me personally, I think the "Documentation" and
> Downloads/Versions/Releases should not be on the left nav. Or, leave them
> on the nav and have them implicitly direct to the
> most-recent-prod-release-family.
> But overall I had envisioned a release-specific page - specific to release
> families (5.0, 5.1, etc) as opposed to specific micro/bugfix releases
> (5.0.1, 5.0.2, etc). This release page would include:
>
>1. General description - what were the main points or developments for
>this family?
>2. Links to its documentation
>3. List of all micro/bugfix releases as a sort-of simplified
>changelog. This part is still unclear in my head as to the best way to
>represent this information, but ultimately each entry in this list would
>need to include:
> 1. announcement URL
> 2. sysopsis of the main fixes/changes
> 3. link to the full changelog
>
> For the most part, the information I listed for the micro/bugfix release
> entries is covered in the release announcement so one option is to simply
> link to each announcement for that family - possibly driven by the release
> yaml files.
>
> This also fixes what I find to be a very confusing list of "latest"
> releases. I think that works much better as a single entry on the release
> family page.
>
> Will what you did "work" for ORM? Sure. What I describe is just what I
> personally think would be better in terms of ORM needs, but I have
> absolutely no resources to do that atm. So for now, whatever y'all deem is
> best is probably the best way to go.
>
>
> On Fri, Sep 8, 2017 at 8:11 AM Sanne Grinovero
> wrote:
>
>> Thanks Yoann!
>> Looks great.
>>
>> Two minor suggestions:
>> - could the two links we have for each release on search/releases/ on
>> two separate lines? Or something else to make it clear that there are
>> two linkes.
>> - Regarding the "Compatibility matrix", the header line (the one in
>> black) .. I think we need to clarify in some way that you're referring
>> to Hibernate Search releases. Possibly just link to the page
>> describing the family?
>>
>> Thanks,
>> Sanne
>>
>>
>> On 8 September 2017 at 13:53, Yoann Rodiere wrote:
>> > Hey,
>> >
>> > I pushed an update to staging. I only converted the "Search" part for
>> now.
>> > What changes:
>> >
>> > The _data folder structured changed a bit, so that we can introduces a
>> YAML
>> > file for each series (5.5, 5.6, 5.6, 5.8, ...), containing a summary of
>> this
>> > series and a list of integration constraints (ORM > 5.2, etc.)
>> > The "Downloads" page is renamed to "Releases", since, well, it's about
>> more
>> > than just downloads. See http://staging.hibernate.org/search/releases/
>> > The "Releases" page now includes a "Compatibilty matrix" section based
>> on
>> > the new data I mentioned above
>> > The "Releases" page now includes links to one page for each series
>> ("More on
>> > the 5.8 series")
>> > There is now one page for each series (see
>> > http://staging.hibernate.org/search/releases/series/5.8/). This page
>> > includes:
>> >
>> > A short (one-li
Re: [hibernate-dev] [Search and more] What is new in a give release
Following Steve's comments, I made another few changes for the sake of usability: - Moved the series-specific pages so that the path is more consistent with ORM documentation; the series-specific page for Search 5.8, for instance, is now http://staging.hibernate.org/search/releases/5.8/ - Changed the list of releases in the "releases" page: renamed "Latest releases" to "Maintained series", and made the series version more prominent, on the left, while the latest release version is a bit less prominent, on the right. That way the list should be a bit less confusing. - Added links to the reference from the "Releases" page: http://staging.hibernate.org/search/releases/ - Added a hero-unit at the top of the series-specific pages, with a few links: http://staging.hibernate.org/search/releases/5.8/ Yoann Rodière Hibernate NoORM Team yo...@hibernate.org On 8 September 2017 at 16:44, Yoann Rodiere wrote: > Steve, > > If I understood correctly, the main difference between what I did and what > you want is you don't want a "hub" pointing to different versions, you want > to redirect to the page for the latest version, and from there allow to > move to another version using drop-down. > While I can understand you'd want that for ORM, I'm not sure it's such a > good idea for projects such as Search or OGM, where the difference between > two families is not only about features, but also (and in some cases, > mainly) about which versions of other components it can integrate with. In > this case, I'm not sure a drop-down would be enough to guide users to the > correct version... > > As for your other concerns: > >- I'll try to add a links to the "documentation" page specific to each >series, both in the main "releases" page and in each series-specific page. >- The list of all micro/bugfix releases is already there, at the >bottom of the page: http://staging.hibernate.org/search/releases/5.8/ >I'll see if I can add some sort of table of contents at the top to >make it more visible. >- The link to the full changelog is already there, though maybe it's >not very visible. > > > Yoann Rodière > Hibernate NoORM Team > yo...@hibernate.org > > On 8 September 2017 at 16:05, Steve Ebersole wrote: > >> For me the real problem is that its not just Downloads/Releases that >> should be (need to be really) treated in this manner - our documentation is >> also family specific. >> >> So for ORM I had envisioned a "versions" (although "releases" works just >> as well) component to the url scheme. Vlad did this for documentation (see >> the version drop down), but we have not yet tackled this for versions - too >> many other more pressing tasks. Also, I am not sure yet the best overall >> structure for this - some of the project related information is not >> version-specific (FAQ, Books, Paid Support, etc) while others are. >> >> To me personally, I think the "Documentation" and >> Downloads/Versions/Releases should not be on the left nav. Or, leave them >> on the nav and have them implicitly direct to the >> most-recent-prod-release-family. But overall I had envisioned a >> release-specific page - specific to release families (5.0, 5.1, etc) as >> opposed to specific micro/bugfix releases (5.0.1, 5.0.2, etc). This >> release page would include: >> >>1. General description - what were the main points or developments >>for this family? >>2. Links to its documentation >>3. List of all micro/bugfix releases as a sort-of simplified >>changelog. This part is still unclear in my head as to the best way to >>represent this information, but ultimately each entry in this list would >>need to include: >> 1. announcement URL >> 2. sysopsis of the main fixes/changes >> 3. link to the full changelog >> >> For the most part, the information I listed for the micro/bugfix release >> entries is covered in the release announcement so one option is to simply >> link to each announcement for that family - possibly driven by the release >> yaml files. >> >> This also fixes what I find to be a very confusing list of "latest" >> releases. I think that works much better as a single entry on the release >> family page. >> >> Will what you did "work" for ORM? Sure. What I describe is just what I >> personally think would be better in terms of ORM needs, but I have >> absolutely no resources to do that atm. So for now, whatever y'all deem is >> best is probably the best way to go. >> >> >> On Fri, Sep 8, 2017 at 8:11 AM Sanne Grinovero >> wrote: >> >>> Thanks Yoann! >>> Looks great. >>> >>> Two minor suggestions: >>> - could the two links we have for each release on search/releases/ on >>> two separate lines? Or something else to make it clear that there are >>> two linkes. >>> - Regarding the "Compatibility matrix", the header line (the one in >>> black) .. I think we need to clarify in some way that you're referring >>> to Hibernate Se
Re: [hibernate-dev] [Search and more] What is new in a give release
On Fri, Sep 8, 2017 at 9:45 AM Yoann Rodiere wrote:
> Steve,
>
> If I understood correctly, the main difference between what I did and what
> you want is you don't want a "hub" pointing to different versions, you want
> to redirect to the page for the latest version, and from there allow to
> move to another version using drop-down.
>
That's not what I was saying. You can even see that in what the wikis I
pointed to.
I pointed out the drop down to illustrate that this information is all
version-specific (as is release information obviously). Vlad did it that
way because the way hibernate.org is currently defined made that by far
easier to do this just for ORM. A real solution (which you are trying)
would require much larger "infrastructure" changes than we have resources
to tackle. So no, that's not my ideal set up - I've already said that my
ideal set up would be that hibernate.org itself was built to just handle
this because it is true for every multi-release sub-project and its silly
for each sub-project to devise different ways to manage this. You
obviously thought the same since that is what you are trying to do.
In terms of my ideal, let's look in terms of URLs... Essentially I want to
move hibernate.org/{project}/documentation and
hibernate.org/{project}/downloads under a "version scheme", so
hibernate.org/{project}/release/{version}. "version" here means family
(5.0, 5.1, etc). There would also be 2 extra version related urls:
1. hibernate.org/{project}/release/latest - latest-stable-release
2. hibernate.org/orm/release - your "hub", similar to my wikis (
https://github.com/hibernate/hibernate-orm/wiki/Release-Notes,
https://github.com/hibernate/hibernate-orm/wiki/Migration-Guides, etc)
What I was saying with redirects is that we'd have the left nav links point
to "hibernate.org/{project}/release/latest". IMO that matches what most
people would expect.
Each release's page (hibernate.org/orm/release/5.2 e.g.) would contain:
1. synopsis - the purpose of and high-level changes in the release
2. links to its documentation
3. some form of list of its specific micro releases.
I never said your work did or did not have any of these specifics.
As you said, most of this information is currently spread over blog post
announcing the release.
___
hibernate-dev mailing list
hibernate-dev@lists.jboss.org
https://lists.jboss.org/mailman/listinfo/hibernate-dev
Re: [hibernate-dev] [Search and more] What is new in a give release
On 8 September 2017 at 14:46, Yoann Rodiere wrote:
> Sanne, I addressed both your comments. Is it better?
I love it, definitely a step forward!
But we'll need to find some compromise with the requirements of the
other projects - e.g. Steve's feedback - : it should be consistent
across them for people to not get confused.
Minor nitpicking: the compatibility matrix isn't very visible when we
have >=4 releases.
> I also addressed Guillaume's comment on HipChat, and made the compatibility
> matrix a bit... fuzzier, so that we won't have to update it as often. We can
> still make it very specific if we want to, but we won't be limited by the
> layout anymore.
>
> Yoann Rodière
> Hibernate NoORM Team
> yo...@hibernate.org
>
> On 8 September 2017 at 15:11, Sanne Grinovero wrote:
>>
>> Thanks Yoann!
>> Looks great.
>>
>> Two minor suggestions:
>> - could the two links we have for each release on search/releases/ on
>> two separate lines? Or something else to make it clear that there are
>> two linkes.
>> - Regarding the "Compatibility matrix", the header line (the one in
>> black) .. I think we need to clarify in some way that you're referring
>> to Hibernate Search releases. Possibly just link to the page
>> describing the family?
>>
>> Thanks,
>> Sanne
>>
>>
>> On 8 September 2017 at 13:53, Yoann Rodiere wrote:
>> > Hey,
>> >
>> > I pushed an update to staging. I only converted the "Search" part for
>> > now.
>> > What changes:
>> >
>> > The _data folder structured changed a bit, so that we can introduces a
>> > YAML
>> > file for each series (5.5, 5.6, 5.6, 5.8, ...), containing a summary of
>> > this
>> > series and a list of integration constraints (ORM > 5.2, etc.)
>> > The "Downloads" page is renamed to "Releases", since, well, it's about
>> > more
>> > than just downloads. See http://staging.hibernate.org/search/releases/
>> > The "Releases" page now includes a "Compatibilty matrix" section based
>> > on
>> > the new data I mentioned above
>> > The "Releases" page now includes links to one page for each series
>> > ("More on
>> > the 5.8 series")
>> > There is now one page for each series (see
>> > http://staging.hibernate.org/search/releases/series/5.8/). This page
>> > includes:
>> >
>> > A short (one-line) summary of this series
>> > A reminder of the integration constraints for this series
>> > A section about the main changes in this release. I only wrote something
>> > for
>> > the 5.8 series for now, and I basically copy/pasted sections from
>> > various
>> > blog posts.
>> > A list of all releases in this series.
>> >
>> > What I didn't do, but could make sense:
>> >
>> > add a sub-menu element under "Releases" for each series
>> > link to the documentation for each of the latest releases from the
>> > "Releases" page
>> > link to the latest documentation and to the migration guides from each
>> > series' page
>> >
>> > What do you all think? Emmanuel, would this address your concerns?
>> > Steve,
>> > would this be a good fit for ORM?
>> >
>> > Yoann Rodière
>> > Hibernate NoORM Team
>> > yo...@hibernate.org
>> >
>> > On 6 September 2017 at 17:16, Steve Ebersole
>> > wrote:
>> >>
>> >> This is something I brought up ages ago wrt ORM. I wanted something
>> >> (although ideally integrated with the "more version friendly"
>> >> hibernate.org
>> >> design) similar to what I did atm on the ORM GitHub wiki. For example,
>> >> for
>> >> 5.2 we have:
>> >>
>> >> https://github.com/hibernate/hibernate-orm/wiki/Roadmap5.2
>> >> https://github.com/hibernate/hibernate-orm/wiki/Migration-Guide---5.2
>> >> https://github.com/hibernate/hibernate-orm/wiki/ReleaseNotes5.2
>> >>
>> >>
>> >> The format could be better and some of this information could be
>> >> combined
>> >> (release notes and migration guide e.g.). But bear in mind that this
>> >> was
>> >> just what I put together to illustrate what I was wanted to do,
>> >> generally
>> >> speaking - so its a bit "rough"
>> >>
>> >>
>> >> On Wed, Sep 6, 2017 at 4:17 AM Sanne Grinovero
>> >> wrote:
>> >>>
>> >>> Thanks for that Emmanuel.
>> >>>
>> >>> I'll fix the one-liner describing the release, I believe we had
>> >>> already noticed this in the past: they need to describe the whole
>> >>> minor not the micro update.
>> >>> The Search roadmap actually also needs a little re-touch, I'll propose
>> >>> a PR for that too.
>> >>>
>> >>> Regarding past roadmaps: I don't like to clutter the roadmap page with
>> >>> the previous copies, especially as they should have a different nature
>> >>> of not being a plan but being a record of what was actually done.
>> >>> Also, we did agree in past meetings to remove all the old ones. e.g.
>> >>> we never ported the release notes for version 3.x and 4.x as back then
>> >>> we decided this was no place for that. Happy to revisit this decision
>> >>> but let's separate them:
>> >>>
>> >>> What about a "past releases" page at the same level of roadmap, and
>> >>> linking to it both from the main Search menu and th
[hibernate-dev] ORM 5.2 issue with getInterceptor() not being a true getter
Hi,
Note to Gail: this is potentially a blocking issue for 5.2.11 for the OGM
upgrade (I thought it was a bug in OGM but apparently, it's an issue with
ORM).
In 5.2 SessionImpl, we now use getInterceptor() instead of accessing the
interceptor field directly because the field has been moved to
AbstractSharedSessionContract.
See for instance the change made here in afterTransactionCompletion():
https://github.com/hibernate/hibernate-orm/blame/master/hibernate-core/src/main/java/org/hibernate/internal/SessionImpl.java#L2443
I think this is an issue as getInterceptor() is not a simple getter but is:
@Override
public Interceptor getInterceptor() {
checkTransactionSynchStatus();
return interceptor;
}
protected void checkTransactionSynchStatus() {
pulseTransactionCoordinator();
delayedAfterCompletion();
}
Thus calling the pulse() method of the TransactionCoordinator, triggering
an implicit join whereas we're in the afterTransactionCompletion() phase.
This is an issue for us as the pulse() method of our TransactionCoordinator
creates Neo4j transactions so when the getInterceptor() method is called in
afterTransactionCompletion(), we create a new Neo4j transaction.
So 2 questions:
- should we really call checkTransactionSynchStatus(); in getInterceptor()?
If feels a bit weird.
- if so, I think we should have a true protected getter (interceptor()
following Steve's convention?) to avoid SessionImpl "pulsing" the
transaction coordinator when accessing the interceptor.
Thanks for your feedback!
--
Guillaume
___
hibernate-dev mailing list
hibernate-dev@lists.jboss.org
https://lists.jboss.org/mailman/listinfo/hibernate-dev
[hibernate-dev] Are the tests in the documentation module expected to run on MySQL only?
Are the tests in the documentation module expected to run on MySQL /
MariaDB only? Or are they expected to run on all databases?
The test org.hibernate.userguide.mapping.basic.SubselectTest is failing
on Firebird, because it has the following subselect:
@Subselect(
"select " +
" a.id as id, " +
" concat(concat(c.first_name, ' '), c.last_name) as clientName, " +
" sum(at.cents) as balance " +
"from account a " +
"join client c on c.id = a.client_id " +
"join account_transaction at on a.id = at.account_id " +
"group by a.id, concat(concat(c.first_name, ' '), c.last_name)"
)
Firebird doesn't have a concat function. According to the version
history, this test previously used the SQL standard concat operator
'||', but this was changed in May with the commit comment "Fix test
failing on MariaDB".
I am surprised that this change wouldn't be failing on other databases
either (unless most of them define a concat function next to supporting
the || operator).
To fix this database independently, it would need to be changed to use
the JDBC concat function escape:
@Subselect(
"select " +
" a.id as id, " +
" {fn concat({fn concat(c.first_name, ' ')}, c.last_name)} as
clientName, " +
" sum(atr.cents) as balance " +
"from account a " +
"join client c on c.id = a.client_id " +
"join account_transaction atr on a.id = atr.account_id " +
"group by a.id, {fn concat({fn concat(c.first_name, ' ')},
c.last_name)}"
)
However, JDBC function escape are (almost) never used in Hibernate
tests, so I wonder if this would need to be handled elsewhere.
What to do? Do I ignore the documentation tests, add an exception for
Firebird or create a pull request with the above change, or something else?
--
Mark Rotteveel
___
hibernate-dev mailing list
hibernate-dev@lists.jboss.org
https://lists.jboss.org/mailman/listinfo/hibernate-dev
Re: [hibernate-dev] Are the tests in the documentation module expected to run on MySQL only?
I test Hibernate with the following DBs mostly:
- H2
- Oracle
- SQL Server
- PostgreSQL
- MySQL and MariaDb
For other databases, it's not guaranteed that all tests will run.
Related to that function, we could other add a change, but it must work on
the DBs above too.
Or, you could just mark the test with @SkipForDialect.
Thanks,
Vlad
On Fri, Sep 8, 2017 at 7:41 PM, Mark Rotteveel wrote:
> Are the tests in the documentation module expected to run on MySQL /
> MariaDB only? Or are they expected to run on all databases?
>
> The test org.hibernate.userguide.mapping.basic.SubselectTest is failing
> on Firebird, because it has the following subselect:
>
> @Subselect(
> "select " +
> " a.id as id, " +
> " concat(concat(c.first_name, ' '), c.last_name) as clientName, " +
> " sum(at.cents) as balance " +
> "from account a " +
> "join client c on c.id = a.client_id " +
> "join account_transaction at on a.id = at.account_id " +
> "group by a.id, concat(concat(c.first_name, ' '), c.last_name)"
> )
>
> Firebird doesn't have a concat function. According to the version
> history, this test previously used the SQL standard concat operator
> '||', but this was changed in May with the commit comment "Fix test
> failing on MariaDB".
>
> I am surprised that this change wouldn't be failing on other databases
> either (unless most of them define a concat function next to supporting
> the || operator).
>
> To fix this database independently, it would need to be changed to use
> the JDBC concat function escape:
>
> @Subselect(
> "select " +
> " a.id as id, " +
> " {fn concat({fn concat(c.first_name, ' ')}, c.last_name)} as
> clientName, " +
> " sum(atr.cents) as balance " +
> "from account a " +
> "join client c on c.id = a.client_id " +
> "join account_transaction atr on a.id = atr.account_id " +
> "group by a.id, {fn concat({fn concat(c.first_name, ' ')},
> c.last_name)}"
> )
>
> However, JDBC function escape are (almost) never used in Hibernate
> tests, so I wonder if this would need to be handled elsewhere.
>
> What to do? Do I ignore the documentation tests, add an exception for
> Firebird or create a pull request with the above change, or something else?
> --
> Mark Rotteveel
> ___
> hibernate-dev mailing list
> hibernate-dev@lists.jboss.org
> https://lists.jboss.org/mailman/listinfo/hibernate-dev
>
___
hibernate-dev mailing list
hibernate-dev@lists.jboss.org
https://lists.jboss.org/mailman/listinfo/hibernate-dev
Re: [hibernate-dev] Are the tests in the documentation module expected to run on MySQL only?
On 2017-09-08 20:23, Vlad Mihalcea wrote: > I test Hibernate with the following DBs mostly: > > - H2 > - Oracle > - SQL Server > - PostgreSQL > - MySQL and MariaDb > > For other databases, it's not guaranteed that all tests will run. > > Related to that function, we could other add a change, but it must > work on the DBs above too. > Or, you could just mark the test with @SkipForDialect. In theory all JDBC drivers should support JDBC function escapes (including the concat escape). I'll see if I can quickly verify this for those databases, and otherwise I'll just add a skip for Firebird. Mark ___ hibernate-dev mailing list hibernate-dev@lists.jboss.org https://lists.jboss.org/mailman/listinfo/hibernate-dev
