mirror of https://github.com/tLDP/LDP
Fixed a validation error, and added a separation between fixing your own
documents, and fixing other peoples' documents.
This commit is contained in:
emmajane
parent
b7464bc303
commit
211c724cbe
|
|
@ -2,25 +2,22 @@
|
|||
<!DOCTYPE book PUBLIC '-//OASIS//DTD DocBook XML V4.2//EN'>
|
||||
-->
|
||||
<chapter id="sg-maintaining">
|
||||
<title>Maintaining Your HOWTO</title>
|
||||
<title>Maintenance</title>
|
||||
|
||||
<para>
|
||||
Just because your document has now been published doesn't mean your
|
||||
<section id="sg-maintaining-support">
|
||||
<title>Maintaining Your Document</title>
|
||||
<para>Just because your document has now been published does not mean your
|
||||
job is done. Linux documentation needs regular maintenance to make sure it
|
||||
is up to date, and to improve it in response to readers' ideas
|
||||
and suggestions. TLDP is a living, growing body of knowledge,
|
||||
not just a publish-and-forget-it static entity.
|
||||
</para>
|
||||
not just a publish-and-forget-it static entity.</para>
|
||||
|
||||
<para>
|
||||
Add relevant mailing lists to your document where people
|
||||
<para>Add relevant mailing lists to your document where people
|
||||
can get support. If you have the time, follow these
|
||||
mailing lists yourself to stay up-to-date on the
|
||||
latest information.
|
||||
</para>
|
||||
latest information.</para>
|
||||
|
||||
<para>
|
||||
Put your email address in the document, and politely request
|
||||
<para>Put your email address in the document, and politely request
|
||||
feedback from your readers. Once you are officially published,
|
||||
you will begin to receive notes with suggestions.
|
||||
Some of these emails will be very valuable. Create a
|
||||
|
|
@ -29,10 +26,9 @@
|
|||
the folder and make updates to your document. If you
|
||||
are following a related mailing list you may also
|
||||
choose to save a copy of important emails from the list to
|
||||
this folder.
|
||||
</para>
|
||||
this folder.</para>
|
||||
|
||||
<note><title>We're not a free support service, but...</title><para>
|
||||
<note><title>We are not a free support service, but...</title><para>
|
||||
Some people who email you will request personal
|
||||
assistance. You should feel free to decline personal
|
||||
assistance if you cannot spare the time. Writing a
|
||||
|
|
@ -41,39 +37,29 @@
|
|||
to reply to all requests and suggest a mailing list that
|
||||
will (hopefully) be able to provide support to your reader.
|
||||
</para></note>
|
||||
|
||||
|
||||
</section>
|
||||
|
||||
<section id="fixingerrors">
|
||||
<title>Fixing Errors</title>
|
||||
<para>
|
||||
If you find an error in your own document, please fix it
|
||||
and re-submit it. You can re-submit your files by emailing
|
||||
them to <email>submit@en.tldp.org</email>. If you've been
|
||||
using the CVS, you can simply <command>cvs commit</command> your revised document
|
||||
and then send an email saying the new version is ready for
|
||||
distribution. Remember to update the revision history at the
|
||||
top of the document.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
If you find an error in someone else's document please
|
||||
contact the author of the document, or the LDP
|
||||
coordinator at <email>discuss@en.tldp.org</email> (<ulink
|
||||
url="http://tldp.org/mailinfo.html#maillists">subscription
|
||||
required</ulink>) and
|
||||
mention the problem and how you think it needs to be
|
||||
fixed.
|
||||
</para>
|
||||
|
||||
<note><title>Taking over unmaintained documentation</title><para>
|
||||
For more information on how to deal with unmaintained
|
||||
documents, please read:
|
||||
<ulink
|
||||
url="http://www.tldp.org/authors/unmaint.html">Unmaintained</ulink>
|
||||
(includes a list of steps to take to take over
|
||||
<quote>ownership</quote> of unmaintained documents, and a
|
||||
list of unmaintained documents).
|
||||
</para></note>
|
||||
</section>
|
||||
|
||||
<section id="fix-own">
|
||||
<title>Fixing Your Own Documents</title>
|
||||
<para>If you find an error in your own document, please fix it and re-submit the document. You can re-submit your files by emailing them to <email>submit@en.tldp.org</email>. </para>
|
||||
|
||||
<para>If you have been using the CVS, you can submit your changes to the CVS tree and then send a note to the submit mailing list (<email>submit@en.tldp.org</email>). In your email please give the exact path of your document in the CVS tree.</para>
|
||||
|
||||
<para>Remember to update the revision history at the top of the document.</para>
|
||||
</section>
|
||||
|
||||
<section id="fix-other">
|
||||
<title>Fixing Other Documents in the Collection</title>
|
||||
<para>If you find an error in someone else's document please contact the author of the document with the correction. If you do not hear back from the author within a <quote>reasonable</quote> amount of time, please email the LDP coordinator at <email>discuss@en.tldp.org</email> (<ulink url="http://tldp.org/mailinfo.html#maillists">subscription required</ulink>) and describe the problem and how you think it needs to be fixed. If the license permits, you may be asked to make the change directly to the document. If the problems are serious, the document may be removed from the collection, or moved to the <quote>Unmaintained</quote> section.</para>
|
||||
|
||||
<note>
|
||||
<title>Taking over unmaintained documentation</title>
|
||||
<para>For more information on how to deal with unmaintained documents, please read: <ulink url="http://www.tldp.org/authors/unmaint.html">Unmaintained</ulink> (includes a list of steps to take to take over <quote>ownership</quote> of unmaintained documents, and a list of unmaintained documents).</para>
|
||||
</note>
|
||||
</section>
|
||||
</section>
|
||||
|
||||
</chapter>
|
||||
|
|
|
|||
|
|
@ -3,12 +3,10 @@
|
|||
-->
|
||||
<section id="transformations">
|
||||
<title>Transformations</title>
|
||||
<warning><title>TLDP can convert your document</title><para>
|
||||
This section is about how to transform documents
|
||||
from DocBook to other formats. If you do not want
|
||||
to transform documents on your own computer you may
|
||||
<emphasis>skip this section</emphasis>.
|
||||
</para>
|
||||
<warning><title>TLDP will convert your document</title>
|
||||
<para>This section is about how to transform documents
|
||||
from DocBook to other formats. If you do not need
|
||||
to transform documents for your own web site, or to proof read the content, please <emphasis>skip this section</emphasis>.</para>
|
||||
|
||||
<para>
|
||||
If you would like to transform your documents for
|
||||
|
|
@ -22,14 +20,12 @@
|
|||
either absolute or relative URIs.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
Another fairly straight-forward package is
|
||||
<para>Another easy-to-use package is
|
||||
<application>xmlto</application>. It is a front-end for
|
||||
<application>xsltproc</application>. It is available as a
|
||||
RedHat, Debian (etc) package or can be downloaded from <ulink
|
||||
url="http://cyberelk.net/tim/xmlto/" />. You can use it to convert
|
||||
documents with:
|
||||
</para>
|
||||
documents with:</para>
|
||||
|
||||
<programlisting>
|
||||
<prompt>bash$ </prompt><userinput>xmlto html <filename>mydoc.xml</filename></userinput>
|
||||
|
|
|
|||
Loading…
Reference in New Issue