Re: [hibernate-dev] Hibernate documentation on GitHub

2015-11-19 Thread Steve Ebersole
That means some form of customized rendering hooks in both DocBook (jDocBook) and Asciidoctor for that to happen, as during rendering is the only time we really understand the correlation between source and rendered output (assuming a mapping from local doc source file to GitHub url). On Thu, Nov

Re: [hibernate-dev] Hibernate documentation on GitHub

2015-11-19 Thread Vlad Mihalcea
Hi Steve, I didn't know of GitBook before. I was thinking if we can embed links in the jboss.org/hibernate documentation to the actual branch/documentation-file in Github. Something like a side arrow that, when being clicked, it can navigate to the GitHub page hosting the actual file that rendere

Re: [hibernate-dev] Hibernate documentation on GitHub

2015-11-19 Thread Steve Ebersole
Vlad, back to your original question... What specifically did you mean? Are you talking about something like https://github.com/integrations/gitbook ? On Fri, Nov 13, 2015 at 3:39 PM Steve Ebersole wrote: > On Fri, Nov 13, 2015 at 3:30 PM Hardy Ferentschik > wrote: > >> Hi, >> >> On Wed, Nov

Re: [hibernate-dev] Hibernate documentation on GitHub

2015-11-13 Thread Steve Ebersole
On Fri, Nov 13, 2015 at 3:30 PM Hardy Ferentschik wrote: > Hi, > > On Wed, Nov 11, 2015 at 02:36:13PM +, Steve Ebersole wrote: > > I think it makes sense to host these on hibernate.org *after* we figure > out > > the version-specific content issues I brought up in Barcelona. > > What issues a

Re: [hibernate-dev] Hibernate documentation on GitHub

2015-11-13 Thread Hardy Ferentschik
Hi, On Wed, Nov 11, 2015 at 02:36:13PM +, Steve Ebersole wrote: > I think it makes sense to host these on hibernate.org *after* we figure out > the version-specific content issues I brought up in Barcelona. What issues are you talking about. I know you want to link to different versions of t

Re: [hibernate-dev] Hibernate documentation on GitHub

2015-11-11 Thread Steve Ebersole
I think it makes sense to host these on hibernate.org *after* we figure out the version-specific content issues I brought up in Barcelona. However, I am kind of torn. Unless I misunderstand that would mean moving the sources out of the upstream projects into the hibernate.org git repo. I worry ab

Re: [hibernate-dev] Hibernate documentation on GitHub

2015-11-11 Thread Hardy Ferentschik
> > Last but not least, afaik the plan was that hibernate.org becomes the place > > where things would get consolidated. > > I'd really like to see them on hibernate.org: have a better > integration (including look& feel), better control the metadata to > make sure people actually find the latest

Re: [hibernate-dev] Hibernate documentation on GitHub

2015-11-11 Thread Sanne Grinovero
On 11 November 2015 at 09:14, Hardy Ferentschik wrote: > Hi, > >> For sure we could try and further lower the bar to contribution (e.g. >> by adding "edit" links which then get you to the source on GitHub, as >> some other projects do). > >> But I'd prefer to leave the rendered output >> on jboss.

Re: [hibernate-dev] Hibernate documentation on GitHub

2015-11-11 Thread Hardy Ferentschik
Hi, > For sure we could try and further lower the bar to contribution (e.g. > by adding "edit" links which then get you to the source on GitHub, as > some other projects do). > But I'd prefer to leave the rendered output > on jboss.org, alongside with all other JBoss project's docs. +1 - this go

Re: [hibernate-dev] Hibernate documentation on GitHub

2015-11-10 Thread Gunnar Morling
Hi Vlad, Do you mean the *rendered output* of the docs? Because the *sources* are on GitHub of course (see the "documentation" module of the individual projects). So users already can contribute to docs by sending pull requests on GitHub (and that's happening sometimes). For sure we could try and