community-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Niclas Hedhman <>
Subject Re: GitHub Pages
Date Tue, 04 Aug 2015 01:30:41 GMT
We (developers) always discuss tools for making documentation easier. But
we (developers) will always cite another hurdle (with tools) for not
contributing more to documentation. In a lot of cases, it doesn't matter
how easy the tools become, it is still the same heroic lot of people whoc
write the docs. Doesn't matter if that is HTML, xdoc. Anakia, docbook,
Maven text, Asciidoc, CMSes, Wiki, Jekyll or gh-pages. The unwilling will
always be able to raise a reason why he can't contribute...

And as a rather active doc writer, I am happy when receiving contributions
in any form, such as email on mailing list, big or small, and I'll gladly
put that in myself. I'd probably be happy with an audio contribution as
well. It isn't the typing that is the hard part, it is coming up with the
accurate Content.

My 2 cents to this never ending debate... ;-)


On Tue, Aug 4, 2015 at 12:23 AM, Christopher <> wrote:

> On Mon, Aug 3, 2015 at 11:51 AM, Owen O'Malley <> wrote:
> > On Mon, Aug 3, 2015 at 8:22 AM, Stian Soiland-Reyes <>
> > wrote:
> >
> >> This looks good.
> >>
> >> So do I understand any of the commiters editing the site would still
> >> need to run Jekyll manually and push (how?), or is there a GitHub like
> >> autobuild?
> >>
> >
> > It is manual, so it isn't as easy as github pages. However, I find that
> > generally I want to run jekyll locally first anyways to debug my changes.
> >
> FWIW, GitHub pages is pretty easy to debug (non-local): push to
> gh-pages in a fork, before doing a PR against the gh-pages branch. If
> ASF ever did provide automated rendering, this is one reason I'd want
> it to be gh-pages compatible (because users who don't/can't have the
> build tools locally, can still make helpful contributions).

Niclas Hedhman, Software Developer - New Energy for Java

  • Unnamed multipart/alternative (inline, None, 0 bytes)
View raw message