263 lines
5.3 KiB
HTML
263 lines
5.3 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
|
<HTML
|
|
><HEAD
|
|
><TITLE
|
|
>TLDP Review Process</TITLE
|
|
><META
|
|
NAME="GENERATOR"
|
|
CONTENT="Modular DocBook HTML Stylesheet Version 1.7"><LINK
|
|
REL="HOME"
|
|
TITLE="LDP Author Guide"
|
|
HREF="index.html"><LINK
|
|
REL="UP"
|
|
TITLE="Distributing Your Documentation"
|
|
HREF="distribute.html"><LINK
|
|
REL="PREVIOUS"
|
|
TITLE="Acknowledgments"
|
|
HREF="crediting-ack.html"><LINK
|
|
REL="NEXT"
|
|
TITLE="Submission to LDP for publication"
|
|
HREF="submission.html"></HEAD
|
|
><BODY
|
|
CLASS="section"
|
|
BGCOLOR="#FFFFFF"
|
|
TEXT="#000000"
|
|
LINK="#0000FF"
|
|
VLINK="#840084"
|
|
ALINK="#0000FF"
|
|
><DIV
|
|
CLASS="NAVHEADER"
|
|
><TABLE
|
|
SUMMARY="Header navigation table"
|
|
WIDTH="100%"
|
|
BORDER="0"
|
|
CELLPADDING="0"
|
|
CELLSPACING="0"
|
|
><TR
|
|
><TH
|
|
COLSPAN="3"
|
|
ALIGN="center"
|
|
>LDP Author Guide</TH
|
|
></TR
|
|
><TR
|
|
><TD
|
|
WIDTH="10%"
|
|
ALIGN="left"
|
|
VALIGN="bottom"
|
|
><A
|
|
HREF="crediting-ack.html"
|
|
ACCESSKEY="P"
|
|
>Prev</A
|
|
></TD
|
|
><TD
|
|
WIDTH="80%"
|
|
ALIGN="center"
|
|
VALIGN="bottom"
|
|
>Chapter 6. Distributing Your Documentation</TD
|
|
><TD
|
|
WIDTH="10%"
|
|
ALIGN="right"
|
|
VALIGN="bottom"
|
|
><A
|
|
HREF="submission.html"
|
|
ACCESSKEY="N"
|
|
>Next</A
|
|
></TD
|
|
></TR
|
|
></TABLE
|
|
><HR
|
|
ALIGN="LEFT"
|
|
WIDTH="100%"></DIV
|
|
><DIV
|
|
CLASS="section"
|
|
><H1
|
|
CLASS="section"
|
|
><A
|
|
NAME="ag-review"
|
|
></A
|
|
>6.4. TLDP Review Process</H1
|
|
><P
|
|
> Before your document is accepted to the LDP collection it will undergo
|
|
at least three formal reviews. These reviews include a <A
|
|
HREF="http://www.tldp.org/HOWTO/LDP-Reviewer-HOWTO/techreview.html"
|
|
TARGET="_top"
|
|
>technical accuracy
|
|
review</A
|
|
>, a <A
|
|
HREF="http://www.tldp.org/HOWTO/LDP-Reviewer-HOWTO/languagereview.html"
|
|
TARGET="_top"
|
|
>language
|
|
review</A
|
|
> and a <A
|
|
HREF="http://www.tldp.org/HOWTO/LDP-Reviewer-HOWTO/metadatareview.html"
|
|
TARGET="_top"
|
|
>metadata
|
|
review</A
|
|
>. All new documents must pass these reviews
|
|
before being accepted into the collection.
|
|
</P
|
|
><P
|
|
> When you feel your document is finished, email a copy to the submit
|
|
mailing list (<TT
|
|
CLASS="email"
|
|
><<A
|
|
HREF="mailto:submit@en.tldp.org"
|
|
>submit@en.tldp.org</A
|
|
>></TT
|
|
>). Please include the title of your document and
|
|
<SPAN
|
|
CLASS="QUOTE"
|
|
>"Final Review Required"</SPAN
|
|
> in the subject line of your email.
|
|
A team of volunteers will be assigned to your document for each of the
|
|
reviews. 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 and finally the metadata 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.
|
|
</P
|
|
><P
|
|
> 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. Ideally this
|
|
exchange will happen in the LDP's <A
|
|
HREF="http://cvs.tldp.org"
|
|
TARGET="_top"
|
|
>CVS</A
|
|
> to better track each of the
|
|
changes that are made, and keep track of the most current version of
|
|
your document.
|
|
</P
|
|
><P
|
|
> Once your document has passed both the technical and language reviews,
|
|
you may submit it by following the instructions in <A
|
|
HREF="submission.html"
|
|
>Section 6.5</A
|
|
>.
|
|
</P
|
|
><DIV
|
|
CLASS="tip"
|
|
><P
|
|
></P
|
|
><TABLE
|
|
CLASS="tip"
|
|
WIDTH="100%"
|
|
BORDER="0"
|
|
><TR
|
|
><TD
|
|
WIDTH="25"
|
|
ALIGN="CENTER"
|
|
VALIGN="TOP"
|
|
><IMG
|
|
SRC="../images/tip.gif"
|
|
HSPACE="5"
|
|
ALT="Tip"></TD
|
|
><TH
|
|
ALIGN="LEFT"
|
|
VALIGN="CENTER"
|
|
><B
|
|
>Comparing Two Source Files</B
|
|
></TH
|
|
></TR
|
|
><TR
|
|
><TD
|
|
> </TD
|
|
><TD
|
|
ALIGN="LEFT"
|
|
VALIGN="TOP"
|
|
><P
|
|
>Your reviewer may make changes directly to your source file, or they may put their suggestions in a separate email. If they are working with the source file directly, and your document is using DocBook XML, you may find <SPAN
|
|
CLASS="application"
|
|
>XMLdiff</SPAN
|
|
> useful to see the changes that your reviewer has made to your source file. It is a python tool that figures out the differences between two similar XML files, in the same way the <SPAN
|
|
CLASS="application"
|
|
>diff</SPAN
|
|
> utility compares text files.</P
|
|
><P
|
|
>XMLdiff is available from <A
|
|
HREF="http://www.logilab.org/projects/xmldiff"
|
|
TARGET="_top"
|
|
>http://www.logilab.org/projects/xmldiff</A
|
|
>.</P
|
|
></TD
|
|
></TR
|
|
></TABLE
|
|
></DIV
|
|
><P
|
|
> For more information on what the reviewers will be looking for, please
|
|
read the <A
|
|
HREF="http://www.tldp.org/HOWTO/LDP-Reviewer-HOWTO/index.html"
|
|
TARGET="_top"
|
|
>Linux Documentation Project Reviewer HOWTO</A
|
|
>.
|
|
</P
|
|
></DIV
|
|
><DIV
|
|
CLASS="NAVFOOTER"
|
|
><HR
|
|
ALIGN="LEFT"
|
|
WIDTH="100%"><TABLE
|
|
SUMMARY="Footer navigation table"
|
|
WIDTH="100%"
|
|
BORDER="0"
|
|
CELLPADDING="0"
|
|
CELLSPACING="0"
|
|
><TR
|
|
><TD
|
|
WIDTH="33%"
|
|
ALIGN="left"
|
|
VALIGN="top"
|
|
><A
|
|
HREF="crediting-ack.html"
|
|
ACCESSKEY="P"
|
|
>Prev</A
|
|
></TD
|
|
><TD
|
|
WIDTH="34%"
|
|
ALIGN="center"
|
|
VALIGN="top"
|
|
><A
|
|
HREF="index.html"
|
|
ACCESSKEY="H"
|
|
>Home</A
|
|
></TD
|
|
><TD
|
|
WIDTH="33%"
|
|
ALIGN="right"
|
|
VALIGN="top"
|
|
><A
|
|
HREF="submission.html"
|
|
ACCESSKEY="N"
|
|
>Next</A
|
|
></TD
|
|
></TR
|
|
><TR
|
|
><TD
|
|
WIDTH="33%"
|
|
ALIGN="left"
|
|
VALIGN="top"
|
|
>Acknowledgments</TD
|
|
><TD
|
|
WIDTH="34%"
|
|
ALIGN="center"
|
|
VALIGN="top"
|
|
><A
|
|
HREF="distribute.html"
|
|
ACCESSKEY="U"
|
|
>Up</A
|
|
></TD
|
|
><TD
|
|
WIDTH="33%"
|
|
ALIGN="right"
|
|
VALIGN="top"
|
|
>Submission to LDP for publication</TD
|
|
></TR
|
|
></TABLE
|
|
></DIV
|
|
></BODY
|
|
></HTML
|
|
> |