Subject:
Re: Linux Documentation needs much work and ideas
From:
Zhi An Ng ####@####.####
Date:
25 Dec 2012 09:26:01 +0000
Message-Id: <CACgwX5fq4NA+A=9QihtNv9-4SsE1oox19880HoEgOebTZe8r8w@mail.gmail.com>
First of all, Merry X'mas to all! :D
Thanks all for the suggestions. I refer to *Paul's* suggestions below and
agree largely with them.
1) The wiki needs some changes, in terms of *aesthetics* (it surely can
look better) and also how we view its purpose. For now I see that those in
this discussion are leaning towards wiki as the main source of information,
mainly because it is *easily readable, editable*, update-able,
verifiable. I have no idea how the back end works because honestly I
haven't used it but I think to modify how the wiki works we have to contact
discuss-owner?
2) Covered this above (aesthetics).
3) I'm not so sure about the integration but this can probably come later
IMO. The first item on the to-do list should be as discussed, cleanly
migrate all the guides and HOWTOs into wiki.
4) Forums can be important especially to facilitate our discussion on
moving stuff to the wiki. It will be a cleaner interface for discussion on
more specific topics, instead of flooding this mailing list. Maybe we can
make do with a free forum first?
Also with regards to *Michael's* point on a work queue. Perhaps I can
suggest a place where we can publicly keep track of our workflow,
Trello<http://www.trello.com/>.
This works like a virtual corkboard where you can stick up lists, notes,
have checklists, comments etc. It could be an overkill we can just use this
page status wiki page
http://wiki.tldp.org/Page_Status and work from there.
*Michael* and *Roger* also mentioned about importing raw, which I think is
a fantastic idea because it gets things done, and when we have time we can
edit it iteratively. We don't need it to be perfect at the first try. I'ld
also like to note that even importing raw initially will take a bit of
manual filtering effort because most of the time a HOWTO or Guide cannot
simply fit into a wiki page, perhaps relevant portions of a various guides
need to be compiled under a single wiki topic/page.
It X'mas where I am now, so here's wishing everyone a fantastic week ahead,
and also a very happy new year! Cheers! :D
Sincerely,
Zhi An
On Tue, Dec 25, 2012 at 5:27 AM, Paul Hendricksen <
####@####.#### wrote:
> I think this topic is important; Zhi has brought up a lot of the history
> of use that is very important. What is critical is to note that TLDP has
> been a source of information use over many years and in the past 12, the
> way we seek it is a whole different story. Back in 1998 and 1999, I used
> the TLDP a lot because man files were the only other way to learn, I didn't
> learn that way - I needed to read. HOWTOs came about and started to go the
> way of the dodo following message boards and wikis. Now, we have YouTube
> and it's becoming more and more personal.
>
> Wiki's can be made to accept change "pending" review and also be a solid
> place to build from because it is database driven. Hard cutting and
> pasting is not out of the question, this can be done but the method of
> attracting new contributors is the key here. If we don't want TLDP to
> disappear into an abyss we need to modify its 1) content management system,
> 2) its presentation and 3) it's user interactions.
>
> Solutions:
> 1) Modify the wiki to work much like Wikimedia and its database driven
> design capabilities.
> 2) Present a modern appeal to the wiki.
> 3) Allow social media logins for contributions
> 4) Provide a discussion forum alongside of the discussion list for
> collaboration.
>
> Thoughts?
>
> Respectfully,
>
> Paul Hendricksen
>
> -----Original Message-----
> From: Zhi An Ng ####@####.####
> Sent: Monday, December 24, 2012 3:23 AM
> To: ####@####.####
> Subject: Re: Linux Documentation needs much work and ideas
>
> I agree that documentation for Linux is spread out all over the web. The
> main places documentation resides are Linux forums, individual
> distribution's forums and wiki.
>
> Personally I feel that forums, HOWTOS and guides, and wikis should not be
> independent. *Wikis provide topical information at an introductory level*.
> They provide sufficient information for troubleshooting, and preliminary
> learning on a topic. When I was starting out, wikis were really helpful,
> for example in topics such as keyboard and wireless. I especially love the
> Arch Linux wiki because they are so comprehensive and clearly written.
> Forums like linuxforums and distribution's forums provide help on more
> specific problems faced by users, and also encourage sharing of code and
> configuration. It is important because that is where a distribution's user
> base interacts, where its community lives.
> As for HOWTOs and guides, such as those on TLDP, they contain in-depth
> knowledge. I personally find them very useful. But most people will not
> probably get pass the first chapter (with reference to the market share of
> Linux).
>
> I was also reading through the discussion list, and picked up an important
> point:
> -The wiki is a "beta holding ground", for guides that were incomplete not
> not ready to be published.
> Personally I do not agree with this but if it was the original intent then
> we probably need to hold some discussion.
>
> As for the presentation of the front-page, I agree that there needs to be
> work done. Aesthetics has gained much importance in recent years and the
> way TLDP looks might have turned quite some people away. I'm not HTML CSS
> wiz (and my design skills are worse), but I will try.
>
> Sincerely,
> Ng Zhi An
>
>
> ______________________
> http://lists.tldp.org/
>
>
