The following section outlines the process of creating and/or maintaining a document for the Linux Documentation Project. This section includes all steps--some of which may not be relevant to your specific document.
Join the discuss mailing list. Authors who are interested in taking over the maintenance of someone else's document should also join this list. This is to make sure the LDP knows who is working on what documentation.
If you have not yet written your documentation, please review our documents (current, unmaintained and in progress) and submit a proposal to the list. Your proposal should include reasons why your document will be different than those already in the collection; or identify a subject that is currently missing from our documentation. For more information about writing proposals, please read Chapter 3, Writing Your Proposal.
For more information about the mailing lists, please read Section 2, “Mailing Lists” or visit lists.tldp.org to subscribe. If your document has already been written, please submit a copy to the discuss list (or include the URL of where it can be found).
Write your document. If your document has not yet been written, please be sure to email the discuss list before you start writing. You may choose whatever format you feel most comfortable in to write your document. If it is not one of the formats accepted by the LDP a volunteer will convert it for you. For more information on writing technical documentation, please read Chapter 4, Write.
If you are adding your own markup, you may also want to join the docbook mailing list. For more information about the LDP DocBook list please read Section 2, “Mailing Lists”. If you would like to start with a template, you may find the templates in Appendix A, Templates useful. There is also a general introduction to markup in Chapter 5, Markup and a section full of examples at Appendix D, DocBook: Sample Markup.
Submit your document for technical, language and metadata reviews. Do this by
emailing your document to
<firstname.lastname@example.org>. In the
subject line be sure give the title of the document. In the body of the
email say that you are ready for the review process. Outline any
additional reviews your document may have already received. You should
be assigned a reviewer within the week. The reviews may take an
additional week each. For more information about this process, please
read Chapter 6, Distributing Your Documentation.
If your document is not already in DocBook or LinuxDoc format, a reviewer will convert it for you.
Once your document has been through each of the reviews a Review Coordinator will approve addint it to the git repository, update the version number to 1.0 and have the document published on the public Web site. For more information about your final submission to the LDP, please read Section 5, “Submission to LDP for publication”.
The volunteer adding markup to your document may choose any accepted markup language. The Author Guide, however, will refer only to DocBook. If you are submitting plain text or some other format, please let the LDP know if you prefer to maintain your document in either LinuxDoc or DocBook, which are the accepted formats for end-results.