Akopia Akopia Services

[Date Prev][Date Next][Thread Prev][Thread Next][Minivend by date ][Minivend by thread ]

RE: documentation discussion (was: Re: [mv] IF tag: [if session login] doesn't work?)



******    message to minivend-users from "Christopher Thompson" <ct@arborinternet.com>     ******

FYI

Mike Heins at one time had a catalog set up on the minivend.com site
specifically for the documentation. I cut up MV3.12 documentation so that
each section and tag was its own file (even ones with no section in the
current docs) and uploaded it all. It was all in SDF format. It was
running under RCS with the goal of being able to have many people work on
the docs by checking in and out the small pieces. I understand he has CVS
running which is what is really needed.

There was a lot of very good discussion on the mvdocs mail list and a good
template for documenting each tag was created. There was an outline for an
overall reorganization of the docs. I think one guy even generated a PDF
version.

At that point it died for many reasons, but a lot of this ground work has
been done.

I have an example of rearranged documentation for MV3.12. If anyone wants
to look at it, email me. And, I still have all of the SDF files, the build
scripts, etc. somewhere.


> -----Original Message-----
> From: owner-minivend-users@minivend.com
> [mailto:owner-minivend-users@minivend.com]On Behalf Of Ed LaFrance
> Sent: Saturday, March 25, 2000 8:35 AM
> To: minivend-users@minivend.com
> Subject: RE: documentation discussion (was: Re: [mv] IF tag: [if session
> login] doesn't work?)
>
>
> ******    message to minivend-users from Ed LaFrance
> <newmedia@newmediaems.com>     ******
>
> Wow - I started something! I'm surprised - but pleased - that
> the database
> idea caught on.  My original though was that the 'docbase' would be
> distributed with minivend, and would be an installation option
> when using
> makecat ("install the documentation database: y/n").  The most current
> version would also be running alongside the catalog demo at
> minivend.com.
>
> The idea of separate site for it is contrary to the spirit of the
> suggestion, I think.  Third party sites are never bad, and if
> it works, so
> be it, but what started this whole thing was a posting from Mike saying
> that he is still interested and willing to expand and improve
> the docs if
> some users would put their money where their mouths are and
> help.  I assume
> this would mean the "official" docs, not a third-party derivative,
> distributed or maintained separately.
>
> So we have yet to hear from Mike himself.  I don't mean to take
> the wind
> from anyone's sails, but I think the time and effort needs to
> go into that
> which users are most likely to use: the official Minivend docs.
>
> - Ed L.
>
> At 07:03 AM 3/25/00 -0800, you wrote:
> >******    message to minivend-users from David Gindelberger
> ><davidgindelberger@yahoo.com>     ******
> >
> >Eran, Chris (and all interested parties)- WOW!  this
> >is a great start!  I would like to use Linux if
> >possible.  I am most familiar with MV under the
> >"unicies" (unixes?), - that is if I get to help out!
> >
> >I think Mike should have the final say on the domain
> >name, but maybe we could throw out some obvious
> >suggestions like "mvdocs.org", "minivenddocs.org" etc.
> >The .com, .net, and .org are available for these two.
> >
> >
> >Anyways, lets throw a few names around and let Mike
> >decide then we can take the discussion to direct
> >e-mail.
> >
> >I'll be out of pocket for a few days (going to San
> >Francisco for the ACS meeting - WooHoo!).  But I'll
> >try to get on one of the public network stations at
> >the meeting.
> >
> >Lets keep the ball rolling!
> >
> >Dave
> >
> >
> >--- Eran Binyamin Zeitoun <eran_zeitoun@karmail.com>
> >wrote:
> > > ******    message to minivend-users from "Eran
> > > Binyamin Zeitoun" <eran_zeitoun@karmail.com>
> > > ******
> > >
> > > Dave,
> > >
> > > Well... Bandwidth..., Hmm... i think i can give some
> > > of our 4MB bandwidth in
> > > the office...,
> > > And since we are hardware distributers.. a disk
> > > space... (Up to 18gb i think
> > > will be enough)...
> > > with a e-mail server..., I also can donate any
> > > domain name choosen and buy
> > > it as an appricate
> > > to this wonderful list...
> > >
> > > Linux or NT?
> > >
> > > Choose... and i will setup a box...
> > >
> > > Ofcourse i think we need to get mike's approval...,
> > > we can also make a mirror to mike's site...
> > > And also a test box for developers who wants to test
> > > things...
> > >
> > > Guys?, what do you say?
> > >
> > > Eran.
> > >
> > > -----Original Message-----
> > > From: owner-minivend-users@minivend.com
> > > [mailto:owner-minivend-users@minivend.com]On Behalf
> > > Of David Gindelberger
> > > Sent: Saturday, March 25, 2000 1:39 AM
> > > To: minivend-users@minivend.com
> > > Subject: Re: documentation discussion (was: Re: [mv]
> > > IF tag: [if session
> > > login] doesn't work?)
> > >
> > >
> > > ******    message to minivend-users from David
> > > Gindelberger
> > > <davidgindelberger@yahoo.com>     ******
> > >
> > > I love the database idea.  I was thinking of
> > > proposing
> > > a site running (what else) but MV.  We could allow
> > > subscribers of the mailing list add examples and
> > > recommend revisions, and put in "tips and tricks".
> > > Kinda like real-time "open source" docs.  I don't
> > > know
> > > if this has been tried before, and may be difficult
> > > to
> > > manage.  I can look into hosting it myself if this
> > > sounds interesting, or if somebody has bandwith to
> > > spare?
> > >
> > > Dave
> > >
> > > --- Mark Stosberg <mark@summersault.com> wrote:
> > > > ******    message to minivend-users from Mark
> > > > Stosberg <mark@summersault.com>     ******
> > > >
> > > >
> > > > > In many of the list postings, in which people
> > > > complain about not having
> > > > > information, it often turns out that they do
> > > have
> > > > it (in the docs, FAQ, Tag
> > > > > Ref, etc), they are just not FINDING it, because
> > > > they are not looking in
> > > > > the right place - which is often not the most
> > > > obvious place.  I usually
> > > > > have to look in more than one spot to find the
> > > > explanation or example I
> > > > > need.  Sometimes I do a text search of the
> > > entire
> > > > docs to find all
> > > > > instances of a term or phrase.
> > > > >
> > > > > So how about doing the docs as a Minivend
> > > > database, with search pages,
> > > > > cross-referencing links, categorization, etc.?
> > > > Distributed with Minivend
> > > > > as part of the demo catalog(s).  Maybe a change
> > > in
> > > > presentation would make
> > > > > them more useful and effective.  Some parts
> > > would
> > > > have to be rewritten to
> > > > > be more modular and less of an "essay", but much
> > > > of the content is easily
> > > > > adapted right now.
> > > > >
> > > >
> > > > Ed, I have a similiar experience. I find a full
> > > text
> > > > search for a term
> > > > is often the best way to find what I want in the
> > > > docs, although
> > > > sometimes I don't always pick the best term to
> > > use.
> > > > :) I agree that some
> > > > restructuring of the current docs is a good idea,
> > > > but I'm unsure of the
> > > > best way to go about it. Perhaps a database would
> > > be
> > > > the best idea. That
> > > > could potentionally make it easy for people to
> > > > submit changes additions
> > > > through a form like:
> > > >
> > > > Name:
> > > > Usage:
> > > > Description:
> > > > Example 1:
> > > > Example 2:
> > > > ...
> > > > Example n:
> > > >
> > > > (I like examples. :)
> > > >
> > > > I know that the "tags" area of the documentation
> > > has
> > > > a mechanized
> > > > format, so that might be a good starting point for
> > > a
> > > > database
> > > > conversion.
> > > >
> > > >     -mark
> > > >
> > > >
> > > >
> > >
> ><<-------------------------------------------------------------->>
> > > > personal website                <    Summersault
> > > > Website Design
> > > >    http://mark.stosberg.com/     >
> > > > http://www.summersault.com/
> > > > -
> > > > To unsubscribe from the list, DO NOT REPLY to this
> > > > message.  Instead, send
> > > > email with 'UNSUBSCRIBE minivend-users' in the
> > > body
> > > > to Majordomo@minivend.com.
> > > > Archive of past messages:
> > > > http://www.minivend.com/minivend/minivend-list
> > > >
> > >
> > > __________________________________________________
> > > Do You Yahoo!?
> > > Talk to your friends online with Yahoo! Messenger.
> > > http://im.yahoo.com
> > > -
> > > To unsubscribe from the list, DO NOT REPLY to this
> > > message.  Instead, send
> > > email with 'UNSUBSCRIBE minivend-users' in the body
> > > to
> > > Majordomo@minivend.com.
> > > Archive of past messages:
> > > http://www.minivend.com/minivend/minivend-list
> > >
> > >
> > > -
> > > To unsubscribe from the list, DO NOT REPLY to this
> > > message.  Instead, send
> > > email with 'UNSUBSCRIBE minivend-users' in the body
> > > to Majordomo@minivend.com.
> > > Archive of past messages:
> > > http://www.minivend.com/minivend/minivend-list
> > >
> >
> >__________________________________________________
> >Do You Yahoo!?
> >Talk to your friends online with Yahoo! Messenger.
> >http://im.yahoo.com
> >-
> >To unsubscribe from the list, DO NOT REPLY to this message.
> Instead, send
> >email with 'UNSUBSCRIBE minivend-users' in the body to
> Majordomo@minivend.com.
> >Archive of past messages:
http://www.minivend.com/minivend/minivend-list

-
To unsubscribe from the list, DO NOT REPLY to this message.  Instead, send
email with 'UNSUBSCRIBE minivend-users' in the body to
Majordomo@minivend.com.
Archive of past messages: http://www.minivend.com/minivend/minivend-list

-
To unsubscribe from the list, DO NOT REPLY to this message.  Instead, send
email with 'UNSUBSCRIBE minivend-users' in the body to Majordomo@minivend.com.
Archive of past messages: http://www.minivend.com/minivend/minivend-list


Search for: Match: Format: Sort by: