Re: [Fab-user] Contributing documentation?

[Jeff Forcier]

Hey Daniel,

Can you highlight which parts of the docs were out of date? In my
recollection the docs, such as they are, should be largely up to date
with 0.1.0 (e.g. config.foo instead of set(foo), stuff like that).

Also, I'm in the middle of doing a big overhaul of Fabric which, if it
goes live, will likely use Sphinx for the docs (and will be different
in may ways from 0.1.0) so I'm loathe to have new docs written just
yet if things are about to change a lot :)

Those two things said, more docs are always good docs, so I at least
would definitely welcome the assistance, especially if/when this new
Sphinxified version comes out. Fair warning: I'm a pretty ruthless
editor, so anything submitted is likely to be worked over somewhat ;)
(Then again, if you're actually a tech writing major, you may not have
much to fear!)

Best,
Jeff

On Sun, Mar 15, 2009 at 2:15 PM, Daniel Beck <address@hidden> wrote:
> Hello,
>
> I started using Fabric last week and it really spared me a lot of
> tedious, time-consuming activity. I'm really pleased with this tool. I
> noticed that the documentation seems well behind the code I
> downloaded--which wasn't too much of a problem, thanks to some helpful
> comments in the source. As a technical writing student who knows a bit
> of Python, I thought contributing to the documentation would be good
> way for me to help out.
>
> But I don't want to duplicate any effort or devote my energy to
> something that's not especially needed at the moment. What docs need
> updating first and what docs don't exist that should?
>
> I'd really like to help out, so if someone would point me in the right
> direction, I'd appreciate it.
>
> Thanks,
>
> --Daniel
>
>
> _______________________________________________
> Fab-user mailing list
> address@hidden
> http://lists.nongnu.org/mailman/listinfo/fab-user
>