Homepage on Github

4 views
Skip to first unread message

Daniel Luebke

unread,
Apr 25, 2012, 10:52:28 AM4/25/12
to bpel...@googlegroups.com
Hi,

I have a question regarding bpelunit.github.com and the differrent .markdown files that we have in our (main) BPELUnit repository.

IMO it would be good to more or less automatically generate the documents section of the homepage by linking to HTML generated out of the .markdown files. Is there any possibility to do this?

Daniel

Antonio García Domínguez

unread,
Apr 26, 2012, 3:33:54 AM4/26/12
to bpel...@googlegroups.com
Hi Daniel,
I'm not very familiar with Github Pages, but it seems that we could do
this by including the main repository as a submodule of the website
repository (maybe /src?) and then using the "include" Liquid to render
the Markdown file.

Otherwise, we'd have to implement some sort of push hook in the source
code repository, and that'd be quite a bit more complicated. I guess
we should try the submodule option first.

Antonio

Tammo van Lessen

unread,
Apr 26, 2012, 8:24:05 AM4/26/12
to bpel...@googlegroups.com
Hi,

I fully agree with Antonio. But would it be valid to ask why we can't
move the docs to the web site project entirely?

Cheers,
Tammo
--
Tammo van Lessen - http://www.taval.de

Antonio García Domínguez

unread,
Apr 26, 2012, 10:43:11 AM4/26/12
to bpel...@googlegroups.com
Hi Tammo,

On 26 April 2012 14:24, Tammo van Lessen <tvanl...@gmail.com> wrote:
> I fully agree with Antonio. But would it be valid to ask why we can't
> move the docs to the web site project entirely?

It's because we're shipping them with our binary distributions,
basically. That, and moving them around would break some links, but
that's not really a big issue.

Cheers,
Antonio

Daniel Luebke

unread,
Apr 26, 2012, 11:07:35 AM4/26/12
to bpel...@googlegroups.com
I think the requirements for the docs are as follows:
- We have docs that will be purely on the homepage (tutorials e.g.)
- We have docs that should be both in the distribution and on the homepage (READMEs, config docs etc)

We could also create a maven task that bundles the docs in the homepage project and makes a ZIP out of them?

Daniel

Antonio García Domínguez

unread,
Apr 27, 2012, 12:00:18 PM4/27/12
to bpel...@googlegroups.com
Hi Daniel,

On 26 April 2012 17:07, Daniel Luebke <daniel...@gmail.com> wrote:
> I think the requirements for the docs are as follows:
> - We have docs that will be purely on the homepage (tutorials e.g.)

Sure.

> - We have docs that should be both in the distribution and on the homepage
> (READMEs, config docs etc)

Sounds good as well.

> We could also create a maven task that bundles the docs in the homepage
> project and makes a ZIP out of them?

Well, we could always create a static mirror of the site with
something like "wget -r", right?

Antonio

Daniel Luebke

unread,
Apr 27, 2012, 1:39:15 PM4/27/12
to bpel...@googlegroups.com


Am Freitag, 27. April 2012 18:00:18 UTC+2 schrieb Antonio García Domínguez:
Well, we could always create a static mirror of the site with
something like "wget -r", right?

The beauty of simplicity and the hidden barriers in our minds...

Antonio García Domínguez

unread,
Apr 29, 2012, 5:16:19 AM4/29/12
to bpel...@googlegroups.com
Hi Daniel,

On 27 April 2012 19:39, Daniel Luebke <daniel...@gmail.com> wrote:
> The beauty of simplicity and the hidden barriers in our minds...

Yes, keeping it simple is always nice :-D. I'll try and whip up a
shell script for that this week, and then integrate it into some
Jenkins job.

Cheers,
Antonio
Reply all
Reply to author
Forward
0 new messages