From: "Erik K." <ummeegge@ipfire.org>
To: documentation@lists.ipfire.org
Subject: Re: IPFire Wiki Workflow
Date: Thu, 11 Jul 2013 19:30:03 +0200 [thread overview]
Message-ID: <54C3C794-4F06-439A-8FD6-56104D4E5A3B@ipfire.org> (raw)
In-Reply-To: <assp.090474f9d2.51DEDAD8.5070105@dailydata.net>
[-- Attachment #1: Type: text/plain, Size: 2872 bytes --]
Hi all,
regarding to the ideas causing a better overview of the wiki content, i have tried a more compressed layout of the configuration wiki. The actual (official) look of this section can be found in here --> http://wiki.ipfire.org/en/configuration/start .
The new one is very unready and only a first try, but it should show an idea how it could be better overviewed.
In here --> http://wiki.ipfire.org/en/configuration/start you belong to the new structure.
Until now there is no content behind the structure but this should be done fast by a copy and paste of the old content. <-- Better to check out some sections before. Another possibility in this kind of structure can be to work more precised in themes with e.g. 5-10 different sections not as before with 40-50 (example in here --> http://wiki.ipfire.org/en/configuration/start ).
A statement to the wiki workflow:
In the last months, mostly work was done in particular articles of the wiki, also to clean up the code cause a lot of plugins was replaced, so the general structure wasn´t touched but becomes more and more informations. I think most important is for the first
* Find out a new structure which can be better overviewed (configuration and installation, ???).
* Go for a checkout of the basic system articles (without addons) and find out the worse sections to make them better and clearer.
* If old articles will be revised, the explained functions should also be tested.
* Documentation should be a part of the development of software (and if it is only a short developer hand out) so a possible documentation "team" have it easier.
Also to overview the actual changes in the wiki needs to be checked. In here --> http://wiki.ipfire.org/start?do=recent a done list can be overviewed. If there was a change in german, it might be great to find it also in the english wiki. As more people looks in there as better it is.
The native speakers: It is very important to have some people especial in english (american/english). The best might be that some people are native in two languages german/english otherwise we have the same condition than before. I tried always my best as an native german speaker to translate the wikis into english, but thats not enough for a good feeling by reading. So i tried always to send some messages over the docu mailinglist with the please that someone can go for corrections (also in german). Sometimes this kind of workflow did it very good (thanks again Rod by the way ;-), but sometimes (especially in the last past months) there was no response. As time goes by the wiki articles leaves the memory that there was something to do and they where forgotten. So it is maybe an idea to mark those articles as "uncheck, everybody is invited to go for a revise" or something.
So for the first some ideas from me.
Greetings
Erik
next prev parent reply other threads:[~2013-07-11 17:30 UTC|newest]
Thread overview: 19+ messages / expand[flat|nested] mbox.gz Atom feed top
2013-07-10 9:46 Michael Tremer
2013-07-10 21:02 ` Aw: " Bernhard Bitsch
2013-07-10 22:24 ` Michael Tremer
2013-07-11 7:28 ` R. W. Rodolico
2013-07-11 10:01 ` Michael Tremer
2013-07-11 16:18 ` R. W. Rodolico
2013-07-11 17:30 ` Erik K. [this message]
2013-07-11 17:54 ` Erik K.
2013-07-11 22:01 ` Michael Tremer
2013-07-12 12:10 ` Aw: " Bernhard Bitsch
2013-07-12 15:02 ` Michael Tremer
2013-07-12 17:58 ` R. W. Rodolico
[not found] <ED6F7E1F-7128-485B-8365-98F6674459B4@ipfire.org>
2013-07-12 12:06 ` embp
[not found] <D8D682F2-7C9C-4962-AA0E-9AD00D3D5003@ipfire.org>
2013-07-12 14:55 ` Michael Tremer
2013-07-27 16:00 ` Erik K.
2013-07-27 16:50 ` Erik K.
2013-07-28 16:27 ` Michael Tremer
2013-07-12 17:50 ` R. W. Rodolico
[not found] <CBA641A3-39FA-42D7-93D2-240B22AF1F79@ipfire.org>
2013-08-02 12:01 ` Michael Tremer
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=54C3C794-4F06-439A-8FD6-56104D4E5A3B@ipfire.org \
--to=ummeegge@ipfire.org \
--cc=documentation@lists.ipfire.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox