The LDP Responds to Suggestions

Guylhem Aznar, one of the folks over at the Linux Documentation Project has sent us an updated list of features/responses/additions that they've put into the project. Much of this work comes as a result of Slashdot suggestions; you can read more below and perhaps want to sign up to help out.

Thanks a lot to Slashdot readers for the comments they submitted.

Our announcement may have seemed "empty" but you provided us with lots of good feedback regarding the LDP in general, and that will help us in improving our quality.

While reading the comments, I took a paper and wrote down the different problems people had.

Some will not be solved immediately, some are now solved, others are outside our scope while others can be solved if we get more people to help in the effort.

- web site design : FIXED

Each of your comments were precious to help us improve its appearance and ease of use. Please try out the new version.

- provide direct access to important links : FIXED

We now have big links for each of the major document types (HOWTOs, FAQs...) on the first page. Please check "non-English" where you should find a link to your local LDP with translated documents.

- provide security bulletins & link to RFC archives

I'm sorry, but this is not within the current goals of the LDP. However, we will add links to other sites with this information in our "Links" section.

- provide DocBook and PDF documents : FIXED (Docbook format and ">PDF format are online now

I converted each of the LinuxDoc HOWTOs and mini HOWTOs to DocBook and PDF, uploaded them two days after the Slashdot article ; they are now available on each of the formats as another output, just like the html and ps versions.

- move to DocBook because LinuxDoc sucks - stick to LinuxDoc because DocBook sucks

The HOWTOs are now provided in both LinuxDoc and DocBook; however for the moment we can only accept LinuxDoc source for the HOWTOs.

In the next weeks both DocBook and LinuxDoc SGML source will be accepted for the HOWTOs. We are currently testing DocBook output formats.

You can already submit your DocBook only document which will be put in the DOCBOOK section. (a new major section, like FAQs and HOWTOs)

- "tables don't scale to window size and resolution and 10 pt font size is hardcoded

Our Webmasters are working on these problems.

- How can I submit my work to the LDP? You can read the HOWTO-HOWTO

three possibilities depending on the format:

a. you can write in LinuxDoc : call your document an HOWTO b. you can write in DocBook : call your document a DOCBOOK :-) c. you are a master of TeX/LaTeX, pdf or any specific format : call your document a GUIDE or a FAQ, depending on its contents.

Please use a license compatible with our requirements (GNU Free Documentation License is IMHO the best choice but feel free to take any other license) and mail your document to ldp-submit@lists.linuxdoc.org

If your LinuxDoc or DocBook source contains errors, I'm sorry but we will not process it until the errors are fixed. Please test it first

- You should check the documents : FIXED

We have since November! We would like to be able to have our peer review team proofread each submitted document.

However, there are far too many docs submitted to ldp-submit for our small team to adequately proofread each document. If you would like to help us please subscribe to ldp-submit (mail ldp-submit-request@lists.linuxdoc.org).

- XXXX and YYYY HOWTOs are outdated/unmaintained

Please update the document and submit the new version to the LDP if the license allows modifications. We will be happy to include your new version (News HOWTO and SCSI HOWTO are especially old!).

- I just found ZZZZ HOWTO which is not part of the LDP yet

Then please contact the author and ask him to send his document to ldp-submit@lists.linuxdoc.org Chances are we will include it, unless it contains errors, has a non- free license, or duplicates an existing document.

- license problem, GNU/Linux... FIXED

We have a manifesto and a license guide on the first page. There is an ongoing discussion and both may be revised.

We will not impose any license but rather have some criteria and requirements (free redistribution for ex.)

And if you don't like "LDP", just remember netscape/mozilla : it's written LDP but it reads GNU Linux Documentation Project.

Writing documentation is not as sexy as writing software (To quote a Slashdotter, "Honestly, how many users want to read documentation? How many of them see a fat manual and feel happy?")

We do need more authors. Unfortunately, not everyone can be a good author. It requires a combination of writing skills, technical knowledge, and the willingness to accept criticism that improves your final product. Thank you all for your responses--we hope that you continue to let us know your opinions on the LDP.

Comments

Sign UP

[reality-bytes]

They will need a lot of help.

The Linux Documentation Project will need all the help it can get; this at the moment can only be an uphill struggle. Linux software development is undoubtedly at its most prolific it has ever been so as soon as something is documented; it will have been revised (something that LDP have taken note of)
It seems therefore that the only way to win this is to increase the manpower available and signup to help...

I emplore /. readers who have knowledge and experience of related issues to get involed (get their keyboard dirty) and be part of the big picture :)
Linuxdoc.org has already proved invaluble to me so I will be doing whatever I can.....