search

gridcf / gct-docs

Grid Community Toolkit documentation
http://gridcf.org/gct-docs/
1 stars 4 forks source link

Automate building .html pages from .adoc files #4

Closed matyasselmeci closed 2 years ago

matyasselmeci commented 5 years ago

A CI script should automate building and deploying changes to .adoc files as HTMLs, so we don't have to remember to do it manually.

fscheiner commented 5 years ago

Should we then split up source files and HTML (plus "static" files like images and other documents) into different branches?

matyasselmeci commented 5 years ago

Yes, I think we should. For OSG documentation, master only contains the source files and the CI builds into a gh-pages branch. I'll give this to @brianhlin since he's the one that set up that system.

fscheiner commented 5 years ago

@brianhlin Any news on this?

brianhlin commented 5 years ago

Hi @fscheiner sorry that this fell off my radar. Is this something we still need?

fscheiner commented 5 years ago

@brianhlin Hi @fscheiner sorry that this fell off my radar. Is this something we still need?

Well, this was actually @matyasselmeci 's proposal. But it would be indeed useful, because whenever committers use different AsciiDoctor versions, the HTML files differ in much more than just the changes in the ADOC files they're based on. So a lot of useless stuff gets in the repo's history over time.

If we can can do with the "features" of Markdown alone, we could do the same as with the gridcf.org site and just host Markdown files and let Jekyll translate that to HTML on the fly. Of course we would then have to change a lot of files and I think the inclusion functionality doesn't work for Markdown - which OTOH could make things actually a little simpler.

Just recognized https://github.com/asciidoctor/jekyll-asciidoc, maybe that could provide a similar functionality with our existing ADOC files.

matyasselmeci commented 5 years ago

I've started working on having Travis do this using asciidoctor; you can see the changes on my gh-pages-travis branch: https://github.com/matyasselmeci/gct-docs/tree/gh-pages-travis

fscheiner commented 2 years ago

Fixed with #26 and https://github.com/gridcf/gct-docs/commit/c8ecc9696b0bbbab203703cf372d05766d166081, https://github.com/gridcf/gct-docs/commit/11d4eff576249f3773c0a14379cdceee5eee326a and https://github.com/gridcf/gct-docs/commit/ec20e78876f2126d968a7af63ecd43cb6a66e1d0.