fff-rs / juice

The Hacker's Machine Learning Engine

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Link to the book is broken

naktinis opened this issue · comments

README.md is linking to the book at https://spearow.io/juice/book, but the page returns a "not found" response.

The underlying issue here is that right now I am not sure how to publish the book automatically, since the GH page is already used for the API docs.
I am also reluctant splitting the book into it's own crate posaible getting out of sync with the actual implementation.

Anyone some input?

what does the CI do right now? if there is someplace to put a hook like post-receive etc. then the book directory could be sent over to the URL with rsync or something similar once generated?

The question is to how to deploy it, which tooling is necessary. The CI can do whatever is needed :)

Right now it does nothing with the book since there is no definition on how to deply it.

How are the docs deployed right now? I don't see a travis file in the repo.

@Anton-4 No travis, it's all concourse right now. The main reason is that travis has not GPU access (afaik).https://ci.spearow.io and config is at https://github.com/spearow/continuous-integration

I'm probably overlooking something here but can't we just add the following to the gen-doc task for doc-juice:

cd juice/doc/book
mdbook build

and then copy the static HTML files to a book folder so they appear at spearow.github.io/juice/book/?

That should work, scheduled.

A first draft is implemented and deployed and will be execute once juice builds, which is blocked right now by the test failure of coaster-blas fff-rs/coaster-blas#2

The book can be found right here: https://spearow.github.io/juice/book/juice.html force build for now. I will revert the ci back to the current behaviour (only on successful builds push doc updates) whenever fff-rs/coaster-blas#2 is resolved.