Mailinglist Archive: opensuse-project (265 mails)

< Previous Next >
Re: [opensuse-project] openSUSE documentation


On 10/8/19 7:36 PM, jdd@xxxxxxxxx wrote:
Le 08/10/2019 à 09:59, Simon Lees a écrit :

So if openSUSE contributors such as Ish would like to work toward adding
new sections to the openSUSE docbook then I think that's something to be
encouraged rather then telling people to go back to the wiki.

sure, but the wiki is almost free form and docbook is a hell to configure (or at least is was not so long ago), better the wiki than nothing :-)

Yes but at the same time the wiki does not lend itself to producing professional looking printed documents. There has been a suggestion to bridge the two for example the PHP documentation contains the "officially generated" documentation followed by a "User Contributed Notes" section which allows the best of both worlds and keeps everything in one location. (Example [1])

The board discussed this issue at our face to face meeting last year, however with all the other discussions going on its ended up on the back burner (we also thought it might be easy to wait until hosting stuff started to move away from Provo). Potentially a simple way to achieve such a setup would be to embed a discourse [2] thread onto each page of our existing documentation.

Our initial discussions started around the idea of creating an "openSUSE Knowledge Base" with the realisation we have a tonne of good (and occasionally less good) documentation / guides / how too's spread between the documentation provided by SUSE, the wiki and the openSUSE forums then to a lesser extent sites like stack overflow. There are many users who know about one or maybe two of these resources but there are many more that don't know they exist so the idea was to bring as much as possible into a central location. This is not something the current board has time to drive but i'm mentioning it now because if others would like to take it on and drive it, it would benefit the whole community.


1. https://www.php.net/manual/en/language.expressions.php
2. https://www.discourse.org/

--

Simon Lees (Simotek) http://simotek.net

Emergency Update Team keybase.io/simotek
SUSE Linux Adelaide Australia, UTC+10:30
GPG Fingerprint: 5B87 DB9D 88DC F606 E489 CEC5 0922 C246 02F0 014B
--
To unsubscribe, e-mail: opensuse-project+unsubscribe@xxxxxxxxxxxx
To contact the owner, email: opensuse-project+owner@xxxxxxxxxxxx

< Previous Next >