mirror of https://github.com/tLDP/LDP
244 lines
9.0 KiB
XML
244 lines
9.0 KiB
XML
<!--
|
|
<!DOCTYPE book PUBLIC '-//OASIS//DTD DocBook XML V4.2//EN'>
|
|
-->
|
|
<chapter id="distribute">
|
|
<title>Distributing Your Documentation</title>
|
|
|
|
<section id="pre-distribute">
|
|
<title>Before Distributing Your Documentation</title>
|
|
<para>
|
|
Before you distribute your documentation, there are a few more
|
|
things that you will need to check and possibly add to your document.
|
|
</para>
|
|
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term>Spelling and Grammar Check</term>
|
|
<listitem>
|
|
<para>
|
|
You can read more about helper applications in <xref
|
|
linkend="ag-spellcheck" />. You should also check your document for
|
|
its overall flow and clarity.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>Abstract and Other Meta Data</term>
|
|
<listitem>
|
|
<para>
|
|
Add a short paragraph which clearly defines the scope of your
|
|
document.
|
|
For more information on how to add this information using DocBook
|
|
please read <xref linkend="metadata-markup" />
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>Acknowledgments</term>
|
|
<listitem>
|
|
<para>
|
|
Give credit where credit is due. For more information about when to
|
|
give credit, read <xref linkend="crediting-ack" />.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>License and Copyright</term>
|
|
<listitem>
|
|
<para>
|
|
The LDP distributes documents, however, the author maintains the
|
|
copyright on the document. All documents accepted by the LDP must
|
|
contain a license and copyright notice. You can read more about this
|
|
in <xref linkend="doc-copyright" />.
|
|
You may also want to add a Disclaimer, but this is optional. More
|
|
about this in <xref linkend="doc-disclaimer" />.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>Validate the Markup</term>
|
|
<listitem>
|
|
<para>
|
|
If you are submitting a DocBook or LinuxDoc document, make sure the
|
|
markup is valid. Read why in <xref linkend="why-validate" />.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
|
|
<varlistentry>
|
|
<term>Obtain Peer Reviews</term>
|
|
<listitem>
|
|
<para>
|
|
You may want to have others review your document before
|
|
submitting it to the LDP. Ask people for a <ulink
|
|
url="http://www.tldp.org/HOWTO/LDP-Reviewer-HOWTO/peerreview.html">Peer
|
|
Review</ulink> and/or a <ulink
|
|
url="http://www.tldp.org/HOWTO/LDP-Reviewer-HOWTO/techreview.html">Technical
|
|
Accuracy Review</ulink>. Since not all mailing lists will respond favorably
|
|
to attachments, you may wish to set up a temporary web site which houses your
|
|
document. Note: this is absolutely <emphasis>not</emphasis> required.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
|
|
<section id="doc-licensing">
|
|
<title>Licensing and Copyright</title>
|
|
<para> In order for a document to be accepted by the LDP,
|
|
it must be licensed and conform to the <quote>LICENSE
|
|
REQUIREMENTS</quote> section of the LDP Manifesto located at <ulink
|
|
url="http://www.tldp.org/manifesto.html">http://www.tldp.org/manifesto.html</ulink>.
|
|
</para>
|
|
|
|
<para> We recommend using the <ulink
|
|
url="http://www.gnu.org/copyleft/fdl.html">GNU Free Documentation
|
|
License (GFDL)</ulink>, one of the <ulink
|
|
url="http://www.creativecommons.org/license">Creative Commons
|
|
Licenses</ulink>, or the LDP license (currently under review). The
|
|
full text of the license must be included in your document, including
|
|
the title and version of the license you are using. The LDP will not
|
|
accept new documents that do not meet licensing requirements.</para>
|
|
|
|
<para>You can get DocBook markups of both the GNU GPL
|
|
and the GNU FDL from <ulink url="http://developer.gnome.org/projects/gdp/licenses.html">
|
|
the GNOME Documentation Project</ulink>. You can then merely
|
|
include the license in its entirety in your document. A
|
|
DocBook-formatted copy of the license is available in
|
|
<xref linkend="templates"/>.
|
|
</para>
|
|
|
|
<para>
|
|
For more information about open source documentation and
|
|
licensing, please check <xref linkend="ref-licenses" />.
|
|
</para>
|
|
|
|
<section id="doc-copyright">
|
|
<title>Copyright</title>
|
|
<para>As an author, you may retain the copyright and add other
|
|
restrictions (for example: require approval for any translations or
|
|
derivative works). If you are a new
|
|
maintainer of an already-existing HOWTO, you must include the
|
|
previous copyright statements of the previous author(s) and the
|
|
dates they maintained that document. </para>
|
|
</section>
|
|
|
|
<section id="doc-disclaimer">
|
|
<title>Disclaimer</title>
|
|
<para>If you would like to include a disclaimer, you may choose
|
|
to use the following:</para>
|
|
<blockquote>
|
|
&disclaimer;
|
|
</blockquote>
|
|
</section>
|
|
|
|
<section id="doc-sourcecode">
|
|
<title>Licensing source code</title>
|
|
<para>If your HOWTO includes bits of source code that you want others to use,
|
|
you may choose to release the source code under GPL.</para>
|
|
</section>
|
|
</section>
|
|
|
|
<section id="crediting-ack">
|
|
<title>Acknowledgments</title>
|
|
|
|
<para>Your document should have an <quote>Acknowledgments</quote> section,
|
|
in which you mention everyone who has contributed to your document in
|
|
any meaningful way. You should include translators and converters, as well as
|
|
people who have sent you lots of good feedback, perhaps the person who taught
|
|
you the knowledge you are now passing on, and anybody else who was instrumental
|
|
in making the document what it is. Most authors put this section at the end
|
|
of their document.
|
|
</para>
|
|
|
|
<para>When someone else assists in the production of an
|
|
LDP document,
|
|
you should give them proper attribution, and there are DocBook tags
|
|
designed to do this. This section will show you the tags you should
|
|
use, as well as other ways of giving credit where credit is due.
|
|
Crediting editors is easy - there is already an
|
|
<sgmltag class="starttag">editor</sgmltag>tag in DocBook.
|
|
But there are two special cases where you need to credit someone,
|
|
but DocBook doesn't provide a special tag. These are <emphasis>translators</emphasis>
|
|
and <emphasis>converters</emphasis>.</para>
|
|
|
|
<para>A <emphasis>converter</emphasis> is someone
|
|
who performs a source code conversion, for instance from HTML to DocBook XML.
|
|
Source code conversions help the LDP achieve long term goals for meta-data,
|
|
and allow us to distribute documentation in many different formats.</para>
|
|
|
|
<para>Translators take your original document and translate it into other
|
|
human-readable languages, from English to Japanese for example, or from German
|
|
to English. Each translation allows many more people all over the world
|
|
to make use of your document and of the Linux operating system!</para>
|
|
|
|
<para>
|
|
We recommend that
|
|
you acknowledge converters in the comment for the
|
|
initial version released in the new format, and
|
|
we recommend that you credit translators in each
|
|
version which they have translated.</para>
|
|
|
|
<note><title>Acknowledgments translated in DocBook</title><para>For more information on how to add these credits using DocBook
|
|
please read <xref linkend="metadata-markup" />
|
|
</para></note>
|
|
</section>
|
|
|
|
<section id="ag-review">
|
|
<title>TLDP Review Process</title>
|
|
|
|
<para>
|
|
Before your document is accepted to the LDP collection it will undergo
|
|
at least two formal reviews. These reviews include a <ulink
|
|
url="http://www.tldp.org/HOWTO/LDP-Reviewer-HOWTO/techreview.html">technical accuracy
|
|
review</ulink> and a <ulink
|
|
url="http://www.tldp.org/HOWTO/LDP-Reviewer-HOWTO/languagereview.html">language review</ulink>. Each new document must pass both of these reviews
|
|
before it is accepted to the collection.
|
|
</para>
|
|
|
|
<para>
|
|
When you feel your document is finished, email a copy to the submit
|
|
mailing list. The review coordinator will assign you a team of
|
|
volunteers who will conduct the reviews of your document. It may take
|
|
up to a week to gather a team who is qualified to review your document.
|
|
Typically the technical review happens first, followed by the language
|
|
review. Your reviewers will read your document give you feedback on
|
|
whether or not they think your document is ready for publication in the
|
|
LDP collection.
|
|
</para>
|
|
|
|
<para>
|
|
Your reviewers may have specific points that must be changed. Once you
|
|
have made the changes submit your document back to your review team.
|
|
They will review the document again and advise you on whether or not
|
|
your document is ready for inclusion in the LDP collection. You may
|
|
need to undergo several edits before your document is ready. Or it may
|
|
not require any additional work. Be prepared to make at least one round
|
|
of changes for both the technical and language reviews.
|
|
</para>
|
|
|
|
<para>
|
|
Once your document has passed both the technical and language reviews,
|
|
you may submit it by following the instructions in <xref
|
|
linkend="submission" />.
|
|
</para>
|
|
|
|
<para>
|
|
For more information on what the reviewers will be looking for, please
|
|
read the <ulink
|
|
url="http://www.tldp.org/HOWTO/LDP-Reviewer-HOWTO/index.html">Linux Documentation Project Reviewer HOWTO</ulink>.
|
|
</para>
|
|
|
|
</section>
|
|
|
|
<!-- Notes on submitting your document to the LDP -->
|
|
&ag-submit;
|
|
|
|
|
|
</chapter>
|