This is where I've run into problems, too - I say "Read the docs" and management and even other techs/engineers simply go "What docs?". That makes people very nervous about adopting Rivendell. I spent an hour today walking a music librarian through adding music via a dropbox and generating a log. This was on a backup system, so there was no real rush, but users being unable to find docs easily for production systems is a big downer. This is one of my prime motivations for sorting out docs. It pains me to see Rivendell be passed over based on lack of clear documentation.

As far as the new/old wiki thing goes - I'd like to end up with a very polished set of docs with no cruft and everything neatly organized. That either means a new wiki, or deleting significant amounts of content, and rewriting nearly all of what doesn't want deleting.

I think that having a second 'new docs' wiki is the way to go to achieve this because the tryphon resource is a great resource and I don't want to lobotimize a lot of the good content in there which people have referred to on this list in many places. I think attempting to rewrite everything in place is significantly more effort than starting from scratch and backporting content, and I don't think it actually helps anyone - if anything it's going to make a lot of links from the archives go to redirects which may or may not be to the content the user was refering to.

I'm also a little nervous because there's been spam issues on the tryphon wiki before and it's on a very old build of MediaWiki, and doesn't seem actively maintained from a web administration standpoint.

So that's my motivation for doing a second wiki. It also has the benefit that if it gets started but not finished, or if people lose interest, we don't break the tryphon wiki any further, so this is lower-risk to existing resources overall.

If nobody has any objections I'd like to at least set up a second wiki for this project and get the ball rolling. Even if we end up using the tryphon wiki, it'd be a good place to try out a new structure and see how it could fit together - a dry fit, if you will.

Cheers,
James


On 12/01/2012 04:19, Daniel Bair wrote:
Agreed!

I was just going through the tryphon wiki today looking for any new documentation... It is very disorganized and not comprehensive. For example I would love to know what all the config elements in rdadmin are for... and I think Fred G. is the only one who knows all of this. Same for callcommander... very sparse on documentation, too. (almost have good debs built for callcommander now, too...lucid/natty)

Infact, where I am working they are paranoid about me leaving and having noone else who knows Rivendell... so much so that they talk about ditching Rivendell and going with something less technical every once in a while.

More organized, better, complete, updated documentation for Rivendell is imperative.

-Daniel Bair
Family First Radio Network


On Wed, Jan 11, 2012 at 8:28 PM, James Harrison <[email protected] <mailto:[email protected]>> wrote:

    Subject: Re: [RDD] Documentation
    To: User discussion about the Rivendell Radio Automation System
    <[email protected]
    <mailto:[email protected]>>
    Message-ID: <[email protected]
    <mailto:[email protected]>>
    Content-Type: text/plain; charset=ISO-8859-1; format=flowed

    The Tryphon wiki is great, but still very disorganized, and trying to
    repair it would, imho, be counterproductive - a fresh start would be
    best for everyone, and the Tryphon wiki is still there to continue
    being
    the great resource it is alongside any new documentation written.
    There's a huge amount of content there but if average users visit it,
    all they get is a huge pile of fairly niche documentation, none of
    which
    is "Rivendell 101". I think we need to do something more
    structured and
    more carefully built to avoid the sort of huge pile-up we have on the
    Tryphon wiki.

    Cheers,
    James




_______________________________________________
Rivendell-dev mailing list
[email protected]
http://lists.rivendellaudio.org/mailman/listinfo/rivendell-dev

_______________________________________________
Rivendell-dev mailing list
[email protected]
http://lists.rivendellaudio.org/mailman/listinfo/rivendell-dev

Reply via email to