ServerGuide reviewers needed

Ahmed Kamal kim0 at ubuntu.com
Mon Aug 22 12:21:35 UTC 2011


On 08/21/2011 09:31 PM, Paul Graydon wrote:
> On 08/17/2011 06:33 AM, Ahmed Kamal wrote:
>> Hi folks,
>>
>> As you know Adam the maintainer of the serverguide had stepped down. 
>> I'm trying to assemble a team of server oriented folks who are 
>> interested in reviewing the Ubuntu server guide (making sure all the 
>> info inside is fresh and accurate), this is only part of it, the team 
>> would also work on creating a fresh chapter on UbuntuCloud 
>> (openstack+orchestra+Ensemble).
>>
>> If you are interested, please raise your hand
>>
>> Cheers
>>
> Hi Ahmed,
>
> Is there a general idea of what level we ought to be aiming the 
> documentation at?  There is a bunch of things that could be added to 
> the MySQL section, for example, without turning it into a full on 
> MySQL Guide (unless that's what we're aiming at?).  Currently it's 
> focussed along the lines of 'this is how you install it, start it and 
> a couple of minor tweaks'.  It could be filled out with brief 
> discussion of the different storage engines provided by the packages, 
> their strengths and weaknesses etc.  The approach seems to vary 
> between different sections of the documentation, and even within the 
> same chapter.  It would seem in general that the database section is 
> woefully lacking in detail compared to other chapters.
>
> Paul
>
Hi everyone,

So I got two questions that I'd like to answer publicly

1- What is our deadline
2- What is the depth needed for the review

My answer is

1- I'm no docs expert, but I checked and Oneiric "documentation string 
freeze" is Sep 15th. Allowing for 10 days for merge proposal 
discussions, we would have only *two weeks* starting today (22Aug-5Sep) 
to get all the content you would like to review in a "ready to merge" 
state from your perspective. As you can see this is not a lot of time, 
so your prompt help is needed

2- Again, since we don't have much time, and since we should not 
re-create upstream documentation, I would try to avoid adding too much 
new content. I would focus this review on only making sure all the 
information in the guide is "correct" and "up-to-date" as of 11.10. This 
would include things like checking package names have not been changed, 
little code snippets actually work...etc. IMO, serverguide should focus 
on the Ubuntu specific parts and not attempt to replace upstream docs, 
with appropriate links to upstream docs

I understand there's a lot that could be added, however the priority is 
making sure the info is correct and up to date

Thanks all for the commitment and hard work!
Keep rocking
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.ubuntu.com/archives/ubuntu-server/attachments/20110822/916895ed/attachment.html>


More information about the ubuntu-server mailing list