[documentation-guide] Added draft section.
Eric Christensen
sparks at fedoraproject.org
Thu Jun 16 18:39:48 UTC 2011
commit bd0c4c8a8ae65d003639cfd9a04b8f99abe53de3
Author: Eric H Christensen <eric at christensenplace.us>
Date: Thu Jun 16 09:49:34 2011 -0400
Added draft section.
en-US/publican.xml | 9 +++++++--
1 files changed, 7 insertions(+), 2 deletions(-)
---
diff --git a/en-US/publican.xml b/en-US/publican.xml
index 36ae473..11e733d 100644
--- a/en-US/publican.xml
+++ b/en-US/publican.xml
@@ -105,8 +105,13 @@ git push</command></para></listitem>
<para>At the top right of every HTML page, the Fedora brand includes a link back to the Fedora documentation site, from a graphic containing the English word "Documentation". We can localise this graphic so that the word "Documentation appears in the same language into which the document itself is translated.</para>
</section>
<section id="chap-documentation_guide-publican-draft">
- <title>Draft Documentation</title>
- <para></para>
+ <title>Marking a Documentation as Draft</title>
+ <para>Release early, release often.</para>
+ <para>Documents can be released before they are completely ready for the users. When this happens it's important to mark and publish the document as a draft. To do this there are three things that need to be done so that everyone knows that the guide isn't complete and ready for public consumption.</para>
+ <para>The first is setting the draft switch in the document itself. To do this you need to add <command>status="draft"</command> to your <literal>Doc_Name.xml</literal> file in the <literal><book></literal> or <literal><article></literal> heading so it looks like <command><book status="draft"></command>. This provides a draft watermark on all pages of the text.</para>
+ <para>The next task is to modify your <literal>Book_Info.xml</literal> or <literal>Article_Info.xml</literal> file. Change the <literal><productname></literal>tag to Fedora Draft Documentation and remove the contents of <literal><productnumber></literal>. Optionally, if you plan to release the document for a particular Fedora release, include the Fedora release number in the <literal><edition></literal> tag. For example, if you plan to release the book for Fedora 14, you would set: <command><edition>14.0.1</edition></command>. Here 14.0.1 signifies Fedora 14, edition 0.1.</para>
+ <para>Lastly, in the <literal>Publican.cfg</literal> add the following lines: <command>version: 0.1</command> and <command>web_version_label: UNUSED</command>.</para>
+ <para>After completing the above tasks your guide will be sufficiently marked as draft and can safely be published to the Docs website.</para>
</section>
<section id="chap-documentation_guide-publican-Building_RPMs">
<title>Building RPMs</title>
More information about the docs-commits
mailing list