rice icon indicating copy to clipboard operation
rice copied to clipboard

Rake Task to Upload Documentation

Open cfis opened this issue 2 years ago • 7 comments

Would it be possible to make a Rake task to upload documentation? I forgot where Rice docs get uploaded to - is it https://github.com/jasonroelofs/jasonroelofs.github.io?

Should Rice docs move to a Rice group or similar in github?

cfis avatar Apr 06 '23 07:04 cfis

The docs are via Github Pages for this repo (the gh-pages branch) so it is possible to do a rake task, though not trivial. How I have it set up is I have a second clone of the repo checked out to the gh-pages branch. Then I run rake doc, copy doc/_build/html to the gh-pages 4.x directory, commit and push.

jasonroelofs avatar Apr 06 '23 12:04 jasonroelofs

I see. I thought gh-pages branch were a thing of the past? And now its better to have a separate repo?

cfis avatar Apr 06 '23 17:04 cfis

No I think that's just two different ways of serving up content depending on what you want the URL to be. We would need to change to a standalone repo if we wanted to move the docs to live at something like rice.github.io.

jasonroelofs avatar Apr 08 '23 13:04 jasonroelofs

Revisiting this...yeah the separate repo is what I did for ruby-prof. What do you think about doing that for Rice @jasonroelofs ?

cfis avatar Feb 25 '24 09:02 cfis

I'm not against the idea. gh-pages is a bit cumbersome to deal with.

jasonroelofs avatar Feb 25 '24 13:02 jasonroelofs

Thinking about this more, maybe it's time to move this into it's own org. github.com/ruby-rice/rice?

jasonroelofs avatar Feb 25 '24 14:02 jasonroelofs

Sounds good to me.

cfis avatar Feb 25 '24 20:02 cfis