[Twisted-Python] web page on doc...

[Kevin Horn]

On Tue, Feb 16, 2010 at 2:18 PM, K. Richard Pixley <rich at noir.com> wrote:

>  Kevin Horn wrote:
>
> xhtml is processed into html by "lore" not "trial".
>
> Doh.  Thanks.  I *knew* that.  I haven't gotten either to work yet, but
> neither is really on my radar right now either.
>
>
Well, I haven't gotten Lore to work (on Windows at least) in a looooooong
time.  The only way I can get trial to work on Windows is by using the
"Twisted Command Prompt", or some hairy PATH manipulation.


>  <http://twistedsphinx.funsize.net>Other than that, something very like
> what you have described should definitely
> be _somewhere_ on the Twisted site.
>
> (As an aside, I think a lot of things that are currently on the wiki should
> be merged
> into the documentation proper, but that's a topic for another post.)
>
> I think I'd need to hear more.
>
> I think there's a subtle distinction between describing the code, usage,
> and interfaces of the twisted library, and describing the people, policies,
> and interfaces of the twisted project.  Generally I think I'd prefer to keep
> them as clearly segregated as possible but there's certainly some grey area
> in between.
>
> --rich
>

For example, if you want to contribute to Twisted, you need to read (at the
very least):

http://twistedmatrix.com/documents/current/core/development/index.html

but you also need to read:
http://twistedmatrix.com/trac/wiki/TwistedDevelopment
http://twistedmatrix.com/trac/wiki/ReviewProcess
and maybe:
http://twistedmatrix.com/trac/wiki/ContributingToTwistedLabs

to really get a full picture.

A lot of this is incomplete on a given page, and you need to have read the
others to really understand what's going on.
Some of that stuff should be merged into the actual development docs (like
the stuff on commit messages, for example).

Some of it certainly belongs in the wiki, but not all of it, and some of
that could be condensed into one page.

Kevin Horn
-------------- next part --------------
An HTML attachment was scrubbed...
URL: </pipermail/twisted-python/attachments/20100216/7a7703f5/attachment.html>