[documentation-guide] Add more to the introduction, and add some remarks to the main file
Jared Smith
jsmith at fedoraproject.org
Sun Mar 23 17:36:29 UTC 2014
commit 693c9ddb169edd63215bdbe8f60798a5b3cee874
Author: Jared K. Smith <jaredsmith at jaredsmith.net>
Date: Sun Mar 23 13:36:08 2014 -0400
Add more to the introduction, and add some remarks to the main file
en-US/Documentation_Guide.xml | 6 ++----
en-US/introduction.xml | 6 ++++++
2 files changed, 8 insertions(+), 4 deletions(-)
---
diff --git a/en-US/Documentation_Guide.xml b/en-US/Documentation_Guide.xml
index b4284ce..bc8b042 100644
--- a/en-US/Documentation_Guide.xml
+++ b/en-US/Documentation_Guide.xml
@@ -7,11 +7,10 @@
<xi:include href="Book_Info.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="Preface.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<!-- Chapters go here -->
+ <remark>Please don't forget to update the introduction.xml file whenever a new chapter gets added</remark>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="introduction.xml"/>
-
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="community.xml"/>
-
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="workflow.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="workflow.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="docbook.xml"/>
<!-- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="docbook-demonstration.xml"/> -->
<!-- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="writing-procedures.xml"/> -->
@@ -23,4 +22,3 @@
<xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<index />
</book>
-
diff --git a/en-US/introduction.xml b/en-US/introduction.xml
index e12a35f..802b3f8 100644
--- a/en-US/introduction.xml
+++ b/en-US/introduction.xml
@@ -76,12 +76,18 @@ your success in your documentation efforts.</para>
</section>
<section>
<title>Organization of this Guide</title>
+ <remark>Please don't forget to update this section whenever a new chapter gets added</remark>
<para>In <xref linkend="chap-community"/>, we will explain the Fedora
documentation community, and how you can join the volunteer effort to
make the world a better place, one instruction at a time.</para>
<para>In <xref linkend="chap-documentation_guide-workflow"/>, we explain the basic workflow
of writing documentation, formatting it, publishing it, and translating it.
</para>
+ <para>In <xref linkend="chap-documentation_guide-docbook"/>, we explain the DocBook
+ markup language that we use when publishing our documentation.
+ </para>
+ <para>In <xref linkend="chap-documentation_guide-tools"/>
+ </para>
</section>
</chapter>
<!--
More information about the docs-commits
mailing list