Re: Documentation Procedure

FredAkbar · Post by **FredAkbar** » Tue Apr 05, 2005 5:23 am

djbsquared wrote:As we post new topics and others seem to get finished, the posts will be reviewed and/or condensed into what will seemingly be the text that makes the wiki. This will be signified by a locked thread. Once a thread is locked, the text in the post will be then be transferred to our wiki. If any changes are needed after this point we ask that you a) start a new thread with [Change] in the subject, or get in touch with Tedger or myself. This will then be addressed. Thanks for the help everyone

Hold on, won't we be able to edit the stuff ourselves once it's been posted? This is a wiki, afterall. At least let us somehow create accounts with which we can log in and make changes.

Post by **The_Tick** » Tue Apr 05, 2005 5:26 am

The wiki will have a severely limited amount of accounts. The forums is where we'll create the originals. No, you won't be able to edit them on your own once in the wiki.

djbsquared · Post by **djbsquared** » Tue Apr 05, 2005 5:29 am

The wiki is a technical term, this is also what will become official documentation and because of this we do not plan to offer access to everybody.

Post by **evands** » Tue Apr 05, 2005 5:49 am

djbsquared and tedger are in charge of documentation... I'm not yet sure exactly how authentication is going to work, but if we can create accounts which allow wiki access without svn commit access I would be okay with, at their discretion, a limited number of other people -- trusted, long time users -- having direct access to it. You'd qualify, for example, Fred.

However, no promises, we're still setting it up, and if the process works better with just the two of them making wiki changes, that's their call. Please don't construe this post as a statement of what will happen... just stating that if it seems such a change would facilitate things, it can probably be worked out.

Post by **The_Tick** » Tue Apr 05, 2005 5:53 am

If it happens that you have to have svn commit access, anyone who is a dev on adium, or myself, can also edit the wiki. We'll have enough people able to do what needs to be done.

Most of the cool parts will be knocked out here by everyone, the tedious formatting will be what tedger and djbsquared have to do.

tedger · Post by **tedger** » Tue Apr 05, 2005 6:00 am

hooray for tedious formatting!

Post by **evands** » Tue Apr 05, 2005 6:45 am

Right now authentication is in a unique file. Aaron is working on getting it to sync with svn authentication... but it's the default to have it separate, in fact.

In any case, whatever y'all want to do.

michael · Post by **michael** » Tue Apr 05, 2005 7:15 pm

What's the address of said wiki?, or is it being kept private while it's still being set up, I'd like to see how it's all coming along. By the way, I really like this new forum, it's nice to have some proper documentation of Adium at last, and it reminds us how great it is

.

Post by **evands** » Tue Apr 05, 2005 7:21 pm

It will be http://trac.adiumx.com, but it's not up yet. Right now nobody but me can authenticate to it, and it's at a ridiculously long URL and devoid of content

Post by **Catfish_Man** » Tue Apr 05, 2005 9:30 pm

evands wrote:It will be http://trac.adiumx.com, but it's not up yet. Right now nobody but me can authenticate to it, and it's at a ridiculously long URL and devoid of content

mmmm..... trac

twopeak · Post by **twopeak** » Thu Apr 07, 2005 7:28 am

totally different thing than how the conversation is going.

Will there be some place where everything in the preferences window is explained?
It seems stupid to explain bits and pieces by answering questions.

There should be one place that explains everything.

And then there also should be a quick startup guide, for users who don't feel like searching where options are, but want to chat NOW.

zaudragon · Post by **zaudragon** » Thu Apr 07, 2005 5:08 pm

twopeak wrote:totally different thing than how the conversation is going.

Will there be some place where everything in the preferences window is explained?
It seems stupid to explain bits and pieces by answering questions.

There should be one place that explains everything.

And then there also should be a quick startup guide, for users who don't feel like searching where options are, but want to chat NOW.

wunderwood's Welcome Screen to the rescue!

Post by **evands** » Thu Apr 07, 2005 8:12 pm

twopeak wrote:Will there be some place where everything in the preferences window is explained?
It seems stupid to explain bits and pieces by answering questions.

Any part of the preferences that isn't self explanatory should be redesigned to be so.

And then there also should be a quick startup guide, for users who don't feel like searching where options are, but want to chat NOW.

Oh, that's easy.
1) Launch Adium
2) Use the first launch screen to add your first account
3) Start chatting

djbsquared · Post by **djbsquared** » Fri Apr 08, 2005 10:53 pm

also, this isnt bits and pieces, this is becoming a wiki. this is not a normal forum for questions and answers, this is people who want to help us get things in order.

Wengero · Post by **Wengero** » Fri Apr 08, 2005 11:03 pm

twopeak wrote:And then there also should be a quick startup guide, for users who don't feel like searching where options are, but want to chat NOW.

i already tried writing one: http://forums.cocoaforge.com/viewtopic.php?t=1510

lemaxou · Post by **lemaxou** » Sat Apr 09, 2005 12:56 am

Coin Coin everyone!

It's secondary, ok, I know

but, please don't forget to translate (An international wiki? And many or one big documentation in pdf?)

Max, international lover

PS: "Coin"= "Quack" in French!

Perez · Post by **Perez** » Sat Apr 09, 2005 2:18 am

I'm not quite sure where this should be posted, but... since this is documentation for an in-progress app., would it make sense to version-stamp each part? Like: "Here's how the contact list works. (v.8.0 b6)"

djbsquared · Post by **djbsquared** » Sat Apr 09, 2005 3:38 am

no, the documentation is not for the current release, but the soon to be released .8 and later. things will be edited so they are correct, but as we approach 1.0 less and less will change.

tedger · Post by **tedger** » Mon Apr 11, 2005 11:54 pm

eventually I'm sure that we'd get the localization people in on things to translate the wiki