[hibernate-dev] ORM - Migration guides: wiki or source repository?

[Steve Ebersole]

The intention was to use the wiki just as a collection of all the links[1]
and have each of those links point to the real migration guides which are
kept in the appropriate source branches.

It was decided to just not do the effort to move older migration guides
which used to be fully written in the wiki.


[1] https://github.com/hibernate/hibernate-orm/wiki/Migration-Guides.

On Mon, Jul 16, 2018 at 1:58 PM Gail Badner <gbadner at redhat.com> wrote:

> If there is any reason to keep the wiki, IMO, it should just refer to the
> version at the appropriate branch in github, e.g,
> https://github.com/hibernate/hibernate-orm/blob/5.3/migration-guide.adoc.
>
> On Mon, Jul 16, 2018 at 11:40 AM, Gail Badner <gbadner at redhat.com> wrote:
>
> > I only update the source...
> >
> > On Mon, Jul 16, 2018 at 2:51 AM, Guillaume Smet <
> guillaume.smet at gmail.com>
> > wrote:
> >
> >> Hi,
> >>
> >> I see that we have a migration-guide.adoc document in the repository:
> >> https://github.com/hibernate/hibernate-orm/blob/master/migra
> >> tion-guide.adoc
> >>
> >> and we also have migration guides in the wiki:
> >> https://github.com/hibernate/hibernate-orm/wiki/Migration-Guide---5.2
> >> https://github.com/hibernate/hibernate-orm/wiki/Migration-Guide---5.3
> >>
> >> Is there a reason why we have both?
> >>
> >> Lately, I updated the wiki one and I just noticed Gail updated the
> source
> >> one. So if we keep both, we will need to keep them in sync but I'm not
> >> sure
> >> there's any value in keeping both. Except having a migration guide
> bundled
> >> in the zip archive, maybe?
> >>
> >> Thoughts?
> >>
> >> Thanks!
> >>
> >> --
> >> Guillaume
> >> _______________________________________________
> >> hibernate-dev mailing list
> >> hibernate-dev at lists.jboss.org
> >> https://lists.jboss.org/mailman/listinfo/hibernate-dev
> >>
> >
> >
> _______________________________________________
> hibernate-dev mailing list
> hibernate-dev at lists.jboss.org
> https://lists.jboss.org/mailman/listinfo/hibernate-dev
>