Mailinglist Archive: opensuse-project (169 mails)

< Previous Next >
Re: [opensuse-project] SDB/Howto/FAQ
  • From: "Rajko M." <rmatov101@xxxxxxxxxxx>
  • Date: Wed, 17 Oct 2007 11:08:27 -0500
  • Message-id: <200710171108.27821.rmatov101@xxxxxxxxxxx>
On Wednesday 17 October 2007 09:54:53 am Martin Lasarsch wrote:
> Hi
>
> ok, i have still the bug open for a long time, here is my point of view for
> discussion. The wiki makes it possible to clutter a lot of pages over the
> whole wiki, or try to make some kind of order.
>
> - is this point of view valid for most of you?
> - do we need the separation?
> - what is missing?
>
> * SDB
> An SDB article should describe a solution to a problem in a special format.
> - separate namespace: SDB:
> - focus should be on beginners, easiest solution first
> - no doctoral thesis, short and to the point 

The 'short and to the point' makes difference to HOWTO. 
I think this should be mentioned on SDB:SDB, SDB:Howto, and any other place 
that new contributor can see. 

> - for more information link to howto and/or FAQ

and any other resource.

> - definition how to write is in the sdb-howto (which is in the SDB, yeah, i
> know ...)

It's a good place, but it is also easy to remedy if it has to be elswhere. 
Copy, link, send email/snailmail to every contributor, whatever is efficient. 

> Examples what not to put into the SDB:
> - article about how to install xen

... because it is too long

> - article describes how to use smart instead of zypper/YaST

... because if you want to use smart, fine, but SDB is SUSE (Solution) 
Database and smart is not official package manager. 

Criteria for SDB article should be that it describes solutions for SUSE 
products. Now how to define what is 'SUSE product'. 

Is KDE or GNOME SUSE product? I don't see that way, but than SUSE specific 
pieces? Are there any?  

Partitioning? I guess yes, as it is produced by SUSE implementation of common 
and own tools. 

Any other system problem? Yes, if it is SUSE specific implementation. 

I would really like that we clarify this, as this is substantial difference, 
to HOWTO articles. 

> Examples which are not SDB articles for me:
> Configuring_Evolution_in_openSuSE_10.2
> Samba_file_sharing_in_openSUSE_-_breaking_through_the_window
> Installing_GRAMPS_in_openSUSE_10.2
> (i just picked 3 from the top, great articles, but not SDB)
>
> * Howto
> A howto has not the restrictions like an SDB article.
> - should have a separate namespace: HOWTO:
> - the purpose is not to solve a problem, but this is not mandatory(?)

The purpose is to solve the problem, by definition. 

> - it could be detailed like a doctoral thesis, but don't have to
> - not mandatory focused on beginners

It is for the beginners, by definition. 
One should be able to solve problem, configure service, starting from 0 
knowledge on topic. 

> - imho, and this might be only my opinion, it should still be written as
> easy as possible.

It is not only your opinion it is one of requirements for any article, 
specially written for beginners. 

> - we already have a launchpage for Howtos
>
> * FAQ
> - should have a separate namespace: FAQ:
> - short and to the point

- if answer is longer than 5 lines, link the article that explains details. 

I guess that FAQ:FAQ should state soft limit to answer length, but we have 
agree on value (5 or 10 lines, or something else). To me 5 seems good, 10 is 
larger than I prefer reading FAQ written by other people 
(I'm tolerant ... to my verbosity) :-)  

> - the general FAQ layout should be known, so no more explanation here
> - we should have a FAQ launchpage with all FAQs on it

FAQ:Index ?

-- 
Regards,
Rajko.
---------------------------------------------------------------------
To unsubscribe, e-mail: opensuse-project+unsubscribe@xxxxxxxxxxxx
For additional commands, e-mail: opensuse-project+help@xxxxxxxxxxxx

< Previous Next >
References