[hibernate-dev] README.adoc of hibernate.org

[Gunnar Morling]

It should be possible to make it work rendered *and* when previewed on
GitHub by defining a suffix for links if you are in the "GitHub
environment":

    ifdef::env-github[:outfilesuffix: .adoc]

See https://github.com/asciidoctor/asciidoctor/issues/417 and
https://github.com/opendevise/asciidoc-samples/blob/master/sandbox.adoc.

--Gunnar


2016-04-04 17:22 GMT+02:00 Emmanuel Bernard <emmanuel at hibernate.org>:

> I liked the idea of the README as a proper webpage. But I can live
> without it and I don't have strong grounded arguments for it.
>
> On Mon 2016-04-04 10:52, Sanne Grinovero wrote:
> > It sounds good to me in principle, but I vaguely remember we
> > intentionally added that README to the website for some reason.
> >
> > I don't remember what the reason was exactly though, so my doubt is
> > that we're actually linking to that URL from somewhere.
> > Let's not rush it and wait for several more opinions :)
> >
> > On 4 April 2016 at 09:16, Guillaume Smet <guillaume.smet at gmail.com>
> wrote:
> > > Hi,
> > >
> > > While setting up my environment for hibernate.org and in.relation.to,
> I
> > > noticed that there are broken links in the README... when we read it on
> > > GitHub (the .adoc extension is missing). It works OK when we read it
> from
> > > the website using http://hibernate.org/README/.
> > >
> > > I expect most people to use GitHub to read this document and the other
> ones
> > > related (docker/README.adoc, survival-guide.adoc).
> > >
> > > I was thinking about adding these files to .awestruct_ignore so that we
> > > don't generate website pages for them and fix them for GitHub browsing.
> > >
> > > Anyone against it?
> > >
> > > --
> > > 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
> _______________________________________________
> hibernate-dev mailing list
> hibernate-dev at lists.jboss.org
> https://lists.jboss.org/mailman/listinfo/hibernate-dev
>