LDP
/
LDP
mirror of https://github.com/tLDP/LDP
0
1
Fork 0
Code Releases Activity

putting the process section into bullet points

This commit is contained in:
emmajane 2004-01-06 06:59:03 +00:00
parent e1adf71e20
commit f129490570
1 changed files with 73 additions and 48 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

121
LDP/guide/docbook/LDP-Author-Guide/ag-overview.xml
View File

@ -59,49 +59,80 @@
</section>
<section id="process">
<title>Summary of The LDP Process</title>
<para>If you are new to the LDP and want to pick up an
unmaintained document or write a new one, join the discussion
mailing list at
<ulink url="http://lists.tldp.org">http://lists.tldp.org</ulink>.
This is to make sure the LDP knows who is working on what
documentation.</para>
<para>Once that part is complete, you may write your
documentation <emphasis>in the format of your
choice</emphasis> and submit a draft to
<email>submit@en.tldp.org</email>. The draft will
be reviewed by an LDP volunteer. In a few short days you will
get the draft and comments from the volunteer. After applying
the comments, you may send this version to the submit list
again for final submission into the LDP. Review criteria are available
in the <ulink url="http://tldp.org/HOWTO/LDP-Reviewer-HOWTO/">LDP Reviewer
HOWTO</ulink>. You should read the LDP Reviewer HOWTO
yourself before
submitting your documentation. (Don't worry, the Reviewer HOWTO pretty short
compared to this guide.)</para>
<section id="process">
<title>Summary of The LDP Process</title>
<para>
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.
</para>
<note><title>Review Types</title>
<para>
Reviewers: Please consult the <ulink
url="http://tldp.org/HOWTO/LDP-Reviewer-HOWTO/">LDP Reviewer HOWTO</ulink> for
information about each of the different types of reviews.
</para>
</note>
<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.
This is to make sure the LDP knows who is working on what documentation.
For more information about the mailing lists, please read <xref
linkend="mailinglists" />.
</para>
</listitem>
<para> <!--please check these changes for correctness!-->
At this point, if you wrote your document in another format, an LDP volunteer will translate
it into some form of markup language. The markup language format
that is currently preferred is Docbook XML, see <xref
linkend="ag-markup" />. Your reviewer will send the finished
document to you. In this guide, we assume the return format is
Docbook XML. All subsequent revisions of your document must use one
of the markup languages accepted by the LDP. If you have markup questions, you may ask the
volunteer who assisted you, or ask the LDP DocBook list. For
more information about the LDP DocBook list please read
<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" />.
</para>
</listitem>
<listitem>
<para>
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
<xref linkend="mailinglists"/>.
</para>
If you would like to start with a template, you may find the templates in
<xref linkend="templates" /> useful. There is also a general
introduction to markup in <xref linkend="ag-markup" /> and a section
full of examples at <xref linkend="using-docbook" />.
</para>
</listitem>
<listitem>
<para>
Submit your document for technical and language 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
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 <xref linkend="distribute" />.
</para>
<para>
If your document is not already in DocBook or LinuxDoc format, a
reviewer will convert it for you.
</para>
</listitem>
<listitem>
<para>
After applying the comments from your reviewers, you may send your revised version to the
submit list for final submission. Again, be sure to include the title
of the document in the subject line. In the body of the email be sure
to include the names of your reviewers.
</para>
</listitem>
</orderedlist>
<tip><title>If you don't submit your document in DocBook format</title><para>
The volunteer adding markup to your document may choose any
@ -109,15 +140,9 @@
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.
</para></tip> <!--end of stuff needing check-->
</para></tip>
<para>
Of course, you can also do the markup to your initial document
yourself, but remember that it is not required. There are lots of
templates to get you started in <xref linkend="templates" />.
</para>
</section>
</section>
<section id="mailinglists">
<title>Mailing Lists</title>