Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jeweler should support a non-rubyforge publish_docs task. #92

Closed
postmodern opened this issue Feb 17, 2010 · 4 comments
Closed

Jeweler should support a non-rubyforge publish_docs task. #92

postmodern opened this issue Feb 17, 2010 · 4 comments

Comments

@postmodern
Copy link
Contributor

Now that the rubyforge tasks are slowly being deprecated, Jeweler should provide a task for publishing documentation along with the release of a version. At the minimum a publish_docs task might accept a host, port and path to rsync the documentation directory to. This publish_docs task should be invoked along with the release task, so that the published documentation is coupled to the released version.

@technicalpickles
Copy link
Owner

Personally, I'd prefer not to do any documentation publishing, and instead rely on rdoc.info for hosting.

But, if there's enough need for it, I could see something like documentation:release, and then have it use the same paradigm as the old rubyforge task had for hooking into the release process.

@dreamcat4
Copy link

Hi,
Ive really got an itch to scratch with you on this one.

Link to original discussion:
http://www.ruby-forum.com/topic/205123

If i write all of the necessary code, would you be kind enough to allow grancher to be either embedded, or included as a gem dependency of jeweler? This whole problem becomes easier with grancher. Dont mind if documentation:release task is not by default included in rake release. But as long as jewler can have the code necessary to do it, then can be easily enabled my people in their configuration files, or something right?

@postmodern
Copy link
Contributor Author

If everything goes as planed, I will be moving most of my documentation to a third-party server that my friends run. Thus I would need the ability to rsync the /doc(s)?/ directory out to the server. If Jeweler needs an rsync interface, I already have multiple instances of code laying around to call rsync.

@dreamcat4
Copy link

Ah postmodern,

Well the use case i am referring to is out-of-the-box gh-pages support for TP's suggested documentation:release rake task. Perhaps I overlooked your references to rsync here in the opening comment. Not so sure what your talking about.

My questions were directed to TechnicalPickles here, and whether to (will he or wont he?) allow me to use grancher in a contribution to jeweler.

Sorry for any confusion, but I dont believe thats the solution that your looking for, postmodern.

I'll just open a seperate issue for my request.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants