Topic: Documentation questions

[uniqsys]

As part of the Documentation Team, maybe I should know this, but I would like to know if the Administration and User manuals are locked for editing.  The contribs, How To's and FAQ's are editable but I wanted to clarify something in the Administration manual and was unable to gain access to edit.  I am willing to help.  Is there a procedure I am not aware of that I need to follow?   

Thanks.

[raem]

uniqsys

I seem to have read before that yes, they are locked for consistency/accuracy of information issues.
Post your proposed changes to the Discussion page.

[uniqsys]

uniqsys

I seem to have read before that yes, they are locked for consistency/accuracy of information issues.

I thought as much.  But we should have a formal mechanism to suggest changes to it, unless it is the bug tracker.

Post your proposed changes to the Discussion page.

I suppose you mean this page?  If we have procedures in place, I can't find them to read and follow them so here goes.

What I would like to add is to this page http://wiki.contribs.org/SME_Server:Documentation:Administration_Manual:Chapter13 regarding the software installer.  I think it would be good to add a link to http://wiki.contribs.org/Adding_Software to further explain to the reader how yum works and how to work on repositories and updates; and also to help explain the dangers and benefits of activating repos.

Also, while I am thinking about it, could we add to the Wiki Main Page a section on SME Server, Inc Policies & Procedures?  Maybe we could put in there a link to our constitution, a list of who the officers are, procedures on things like this thread,  the election process, have a noobee page to explain the ropes, a notice to POST ALL BUGS AND POTENTIAL BUGS TO THE BUG TRACKER,etc.  Maybe more direction on these kinds of things will help people navigate better.

Thanks.

[cactus]

I thought as much.  But we should have a formal mechanism to suggest changes to it, unless it is the bug tracker.

May I ask why you explicitly exclude the bug tracker?

I suppose you mean this page?  If we have procedures in place, I can't find them to read and follow them so here goes.

No, we mean this page: http://wiki.contribs.org/index.php?title=SME_Server_talk:Documentation:Administration_Manual, which would be the second tab on the top of the article.

What I would like to add is to this page http://wiki.contribs.org/SME_Server:Documentation:Administration_Manual:Chapter13 regarding the software installer.  I think it would be good to add a link to http://wiki.contribs.org/Adding_Software to further explain to the reader how yum works and how to work on repositories and updates; and also to help explain the dangers and benefits of activating repos.

I do not see the need to add this to the Administrators Manual, the proper context would be the Technical Manual and as you can see here it is already linked in to that.

Also, while I am thinking about it, could we add to the Wiki Main Page a section on SME Server, Inc Policies & Procedures?  Maybe we could put in there a link to our constitution, a list of who the officers are, procedures on things like this thread,  the election process,

I disagree, since this does not concern contribs, it concerns smeserver.org and therefore it deserves a link in the wiki to the proper page on smeserver.org if it exists...

have a noobee page to explain the ropes, a notice to POST ALL BUGS AND POTENTIAL BUGS TO THE BUG TRACKER,etc.  Maybe more direction on these kinds of things will help people navigate better.

I think the main page is crowded and containing a lot of data. I do not see how adding things you mention would make things go smoother. I think users should first read the manuals, re-read it and read it again (yes indeed, you read it correct I suggest you read the manuals at least three times), post to the forums if they need help and (follow up the direction on posting to the forums stating to) take problems concerning SME Server to the bug tracker.

[uniqsys]

May I ask why you explicitly exclude the bug tracker?

I don't.  I just didn't know if it was.

No, we mean this page: http://wiki.contribs.org/index.php?title=SME_Server_talk:Documentation:Administration_Manual, which would be the second tab on the top of the article.

How was I to know that?  This is an example of what I am talking about.

I do not see the need to add this to the Administrators Manual, the proper context would be the Technical Manual and as you can see here it is already linked in to that.

Would it hurt to offer people more information where they (as administrators) might quickly find it?

I disagree, since this does not concern contribs, it concerns smeserver.org and therefore it deserves a link in the wiki to the proper page on smeserver.org if it exists...

OK you disagree, but in fact you agree.  What I meant by a section could be implemented as a link to a section somewhere.  It doesn't matter where, even if it is smeserver.org.

By the way, do you always go to smeserver.org when looking for sme information? You say  "if it exists..."  Why would you put smoething that could be helpful at a site that you are not even sure exists?  Why is the election process mentioned here if smeserver.org is supposed to track that kind of information and process.  Obviously it is because most people come to contribs.org first as this is the link most referred to at smeserver.org.  So why not have a link to this information somewhere?

I think the main page is crowded and containing a lot of data. I do not see how adding things you mention would make things go smoother.

I agree.  The WIKI main page is crowded.  But can't there be a link, one little link to this kind of information so people can easily get educated.  You are looking at it from a "learn the server software" point of view.  That is good, but broaden it a bit and see this as a community.  Learning the software is only one part.  Some members, especially new ones might like to know how the procedures work. Even if they are directed to another site.

I think users should first read the manuals, re-read it and read it again (yes indeed, you read it correct I suggest you read the manuals at least three times), post to the forums if they need help and (follow up the direction on posting to the forums stating to) take problems concerning SME Server to the bug tracker.

I whole heartedly agree.  Read, Read and RE-read.  I think the more links we have to good information can be very helpful to people.  Which brings us back to the main suggestion... a link on the Admin Manual page....and the procedure of implementing/discussing the proposed change.  Maybe this is just turning out to be a discussion on having a Procedures Manual in the Wiki.  What do you think? 

[raem]

uniqsys

On the wiki main page is a link to Wiki Help, which takes you here
http://wiki.contribs.org/Help:Contents

It details using the Discussion tab page
http://wiki.contribs.org/Help:Editing_pages


If you feel a "Procedures" page is required (eg as that information is missing or hard to find), then create it yourself. If others like it, then a link to it can be added to the main page.