[ZDP] local Zope Documentation

[Jimmie Houchin]

Hello,

I too like local documentation. I think it would be wonderful if I could
have all Zope docs in a local Zope installation.

One of the first things I did was download all of the mailing list(s)
archives and import them into Netscape so that I would have all of that
valuable information locally available.

It would be great if also the available docs, how-tos, guides, etc. had
a centrally available, hierarchically organized page they could be
easily browsed to and viewed or retrieved. Something as central and
important as documentation should not require a search engine to find.

I think it would also be nice if the source code was also in this
documentation tree. So that some of the documentation could hyperlink to
the relevant source when describing it's functionality and use.

If all of this was available for a download and import, woohoo! :)

Later,

Jimmie Houchin

George Runyan wrote:
> 
> i've started compiling all the how-tos.  and seperateing them into a
> heirarchy tree.  this works well for me.
> 
> Why?
> * because I dont like the search results usually spit up when i search for
> something
> * to get to (real) documentation I have to have net access
> * I like to browse how-to's heirarchically (something thats needed badly) -
> you would be amazed how fast you can find 'the right stuff' when its
> organised :P
> 
> ZDoc Effort && ZDP addressing local documentation?  it would be nice if
> there was a centralised up-to-date version of ZDOC.zexp that could be
> downloaded, and imported.  it would provide:
> * preferably 'up-to-date' how-to's, documentaiton, ZBook, etc...
> * all articles on ZOPE (they are growing!)
> * interface into the documentation
> * maybe even a tutorial
> * links to external references (mysql reference, openlink reference, cgi's
> references)
> * all inside a 'easy-to-use' tree structure
> 
> issues:
> * keeping things up to date (updates have to be centralized)
> * what happens when someone needs to be in two directories at once (I'm
> thinking zope equiv to symlinks)
> [ when 'Tutorial on Grokking DTML' could be in both DTML folder and
> Tutorials folder]
> * it being 'bloated' or too big
> * points out the need for a zope dist-utils?
> 
> does anyone think this is a good idea?
> 
> george runyan           grunyan@emerging.com
> 
> _______________________________________________
> ZDP maillist  -  ZDP@zope.org
> http://lists.zope.org/mailman/listinfo/zdp