Date: Thu, 11 May 2017 10:58:43 +0800 From: David STIEVENARD <stievenard.david@gmail.com> To: freebsd-doc@freebsd.org Subject: a howto section in the freebsd wiki ? Message-ID: <40540c06-c07d-a65d-b718-438ed33fae21@gmail.com>
next in thread | raw e-mail | index | archive | help
Dear eminent members of the FreeBSD documentation mailing list,
I started to use freebsd 3 years ago in order to create small IT
infrastructures for the company I work for. I'm more into networking but
I had to get more familiar with a *nix operating system to I tried linux
and freeBSD at the same time, and this last one has my preference (but
I'm still a beginner).
I'd like to create a "howto" section in the FreeBSD wiki to document
installation of applications.
*Why ?*
wiki
- I want to share few tutorials I wrote for myself in blood and tears
i.e. a small (out of date) tutorial I wrote
https://forums.freenas.org/index.php?threads/install-deluge-in-a-jail.28778/
- use the collaboration feature of a wiki to have docs as up to date as
possible. Another differentiator : up to now I'm still amazed to see
that what is available in the portstree is quite up to date, I think it
just needs a bit of documentation to make things more approachable
- I'd like to get experimented users to review, comment, improve
- I'd like to invite people who already write howtos elsewhere to come
write into the wiki
centralized/official
- when I started up digging into linux and freebsd, the main
differentiator for me was that, being alone, I have less things to learn
to achieve tasks with FreeBSD, and the handbook is the foundation of that.
- In it's current form having, let's say, a "how to install samba 4.6.2
as an active directory on FreeBSD 11" or "how to install the <place the
last hotness here>" doesn't seems right, but I still need it...So I'd
like to follow the same "centralized" philosophy and complete the
handbook with this kind of documentation in a wiki.
*Question : *
- The wiki is targeted to developers, so is that OK to write pages for
newbies ?
- note : It's my first time using a wiki but I see some limitations in
moinmoin
- bold characters in a code section seems impossible to do at the
moment
- as seen on https://moinmo.in/HelpOnFormatting -> "the wiki
markup is ignored"
- I tried the with the parser feature -> fail
- contacted the moinmoin team on IRC -> seems impossible to the
one who answered me
- no way to discuss about a page ?
- i.e. in mediawiki
https://www.mediawiki.org/wiki/Project_talk:Sandbox
- no "thanks" system
*My suggestion :
*- start on wiki.freebsd.org in it's actual form
- I'll need some help to get some details fixed
- naming conventions for the howto pages
- create a howto start page
- which convention to use to specify the status of a page : writing
in process / testing / waiting for validation / validated ?
- see how it evolves
As a demonstration of what it could look like, here's a partial draft ->
https://wiki.freebsd.org/DavidStievenard
thanks for reading me,
dasti
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?40540c06-c07d-a65d-b718-438ed33fae21>