redhataccess / ascii_binder

AsciiBinder is an AsciiDoc-based system for authoring and publishing closely related documentation sets from a single source.
https://asciibinder.net
MIT License
76 stars 39 forks source link

Ascii_binder requirement of git repo make it unsuitable for s2i and openshift #139

Closed mscherer closed 4 years ago

mscherer commented 6 years ago

For Project Atomic, I am trying to build a website with https://github.com/projectatomic/atomic-host-docs who use ascii_binder, the goal being to have it show the doc.

However, while it build fine outside of a container, if I start to use s2I ( https://github.com/openshift/source-to-image ), it result into this error:

E0305 14:36:22.976774 32157 util.go:91] Error: The specified docs base directory '/tmp/src' does not appear to be part of an AsciiBinder-compatible repo..

After digging, it seems that ascii_binder do requires the folder to be a git repository, which is not what s2i support for now (as it seems to take a git clone, and just use the source code, not the history).

Could a option to build without requiring git information be added, so ascii_binder repo could be built in s2i ?

bexelbie commented 6 years ago

While for your specific documentation a git repo may not be required to build, it is actually a core requirement of this software because of the way that we handle sites and versions (as git branches).

I suggest you do a git init; git add .; git commit -m initial_commit at the beginning of your script.