mirror of https://github.com/tLDP/LDP
Removed 2.1. Contributing to The LDP (integrated content into the next
section 2.2 The LDP Process).
This commit is contained in:
parent
d50f41f509
commit
381992110c
|
@ -162,6 +162,14 @@ what's on the LDP web site as I'm currently *gasp* offline. -->
|
|||
</abstract>
|
||||
|
||||
<revhistory>
|
||||
<revision>
|
||||
<revnumber>4.3</revnumber>
|
||||
<date>2004-04-04</date>
|
||||
<authorinitials>ejh</authorinitials>
|
||||
<revremark>Removed the section <quote>Contributing to The LDP</quote>
|
||||
duplicated content found in <quote>Summary of The LDP Process.</quote>
|
||||
</revremark>
|
||||
</revision>
|
||||
<revision>
|
||||
<revnumber>4.2</revnumber>
|
||||
<date>2004-04-02</date>
|
||||
|
|
|
@ -4,65 +4,6 @@
|
|||
<chapter id="introduction">
|
||||
<title>Authoring TLDP Documents: An Introduction</title>
|
||||
|
||||
<!--
|
||||
This comment can be deleted after an appropriate amount of time.
|
||||
Section 2.1 The LDP
|
||||
Moved this back into Chapter One - About this guide
|
||||
|
||||
Section 2.2, 2.3, 2.4 DocBook and XML
|
||||
Moved this to two other sections: Markup and one of the
|
||||
Appendices on Converting Documents to DocBook XML.
|
||||
-->
|
||||
|
||||
<section id="newauthors">
|
||||
<title>Contributing to The LDP</title>
|
||||
<para>So you want to help out but you are not sure where to start? Here
|
||||
are a few suggestions to help get you on your way:
|
||||
</para>
|
||||
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>
|
||||
Join the discuss mailing list (more in <xref
|
||||
linkend="mailinglists"/>). You can introduce yourself with a message
|
||||
about yourself including the topics you are interested in writing
|
||||
about. Please scan through the list of <ulink
|
||||
url="http://tldp.org/HOWTO/HOWTO-INDEX/howtos.html">existing documents</ulink>,
|
||||
<ulink url="http://tldp.org/authors/inprogress.html">documents in
|
||||
progress</ulink> and <ulink
|
||||
url="http://tldp.org/authors/unmaint.html">unmaintained
|
||||
documents</ulink> before you post. While the members of the
|
||||
discuss list will have ideas on how you can contribute, it is good
|
||||
to have your own ideas as well.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
Check the <ulink
|
||||
url="http://tldp.org/authors/unmaint.html">unmaintained
|
||||
HOWTOs</ulink> and see if there is a subject that you know about and
|
||||
can continue documenting.</para>
|
||||
|
||||
<para>If you think the subject is out of date and no longer
|
||||
important to the Linux community, please email the discuss list and
|
||||
explain why you think the document should be marked as
|
||||
<quote>obsolete.</quote> Include the title of the document, and the
|
||||
URL as part of your post to the discussion list.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
Email an author who is working on a subject comparable to the one
|
||||
you would like to write about. Ask if they would like help with
|
||||
their document--perhaps there is an additional section that you
|
||||
could contribute to an existing document? Or a new feature that is
|
||||
available for the latest kernel?
|
||||
</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
|
||||
</section>
|
||||
|
||||
<section id="process">
|
||||
<title>Summary of The LDP Process</title>
|
||||
<para>
|
||||
|
@ -75,31 +16,44 @@
|
|||
<orderedlist>
|
||||
<listitem>
|
||||
<para>
|
||||
The first thing all new authors should do is join the discussion
|
||||
mailing list at <ulink url="http://lists.tldp.org">http://lists.tldp.org</ulink>.
|
||||
Authors who are interested in taking over the maintenance of someone
|
||||
else's document should also join this list.
|
||||
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.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
If you have not yet written your documentation, please review our
|
||||
documents (<ulink
|
||||
url="http://tldp.org/HOWTO/HOWTO-INDEX/howtos.html">current</ulink>,
|
||||
<ulink url="http://tldp.org/authors/unmaint.html">unmaintained</ulink>
|
||||
and <ulink url="">in progress</ulink>) 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 <xref linkend="propose" />.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
For more information about the mailing lists, please read <xref
|
||||
linkend="mailinglists" />.
|
||||
linkend="mailinglists" /> or visit <ulink
|
||||
url="http://lists.tldp.org">lists.tldp.org</ulink> 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).
|
||||
</para>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<para>
|
||||
Email the discuss mailing list. Briefly introduce yourself and the topic you
|
||||
plan to write about. For more information about writing proposals,
|
||||
please read <xref linkend="propose" />
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
Write your document. You may choose whatever format you feel most
|
||||
comfortable in. 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 <xref linkend="write" />.
|
||||
Write your document. If your document has not yet been written, please
|
||||
be sure to email the discuss list before you start writing.
|
||||
<emphasis>You may choose whatever format you feel most comfortable
|
||||
in to write your document.</emphasis> 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
|
||||
<xref linkend="write" />.
|
||||
</para>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<para>
|
||||
If you are adding your own markup, you may also want to join the
|
||||
|
@ -114,7 +68,7 @@
|
|||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
Submit your document for technical and language reviews. Do this by
|
||||
Submit your document for technical, language and metadata reviews. Do this by
|
||||
emailing your document to <email>submit@en.tldp.org</email>. 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
|
||||
|
|
Loading…
Reference in New Issue