Contributing to the Hobo documentation isn't quite as easy as editing a
Wiki page, but it isn't really difficult.   I thought I'd throw this out
there so that anytime somebody notices an error or hole in the
documentation, they'd be motivated to fix it.  :)

All of the documentation is stored somewhere on GitHub.  They're all in
Markdown format.

Tag Libraries:   Tag library documentation is generated from comments in
the taglib code itself.  git://github.com/tablatom/hobo.git, in the
hobo/taglibs directory.

Manuals:   Most of the manual pages are stored in the cookbook:
git://github.com/tablatom/hobocookbook.git, in the manual directory.
Some of these are symbolic links instead of text files.  In this case,
they are actually rubydoctest files that are stored in the main hobo
repository.

Thingybob:   This is also in the cookbook, in gitorials/two-minutes.markdown

Agility:  git://github.com/bryanlarsen/agility-gitorial-patches.   The
text is stored in the "comment" for each patch, and the patch itself
contains the code changes for the step.

To submit changes to any of these, you have several options, in order of
ease to us.

1) The easiest is if you make a clone of the project on github, and send
a pull request to Tom & I.

2) If you made the changes on a local git repository, commit all of your
changes, and then type "git format-patch origin/master".  This will
create patch files for each of your commits.   You can then send those
patch files to myself as attachments in an email.

3) You can just send us the files you've changed, and we'll worry about
getting them into git.

All contributions welcome & appreciated.

N.B.  This guide applies to code as well as documentation contributions.

Thanks!

Bryan


--~--~---------~--~----~------------~-------~--~----~
You received this message because you are subscribed to the Google Groups "Hobo 
Users" group.
To post to this group, send email to [email protected]
To unsubscribe from this group, send email to 
[email protected]
For more options, visit this group at 
http://groups.google.com/group/hobousers?hl=en
-~----------~----~----~----~------~----~------~--~---

Reply via email to