This change should enable faster and easier filing of new bugs. Patch
also simplifies the section for both redhat and fedora variants.

https://fedorahosted.org/freeipa/ticket/3754

-- 
Martin Kosek <mko...@redhat.com>
Supervisor, Software Engineering - Identity Management Team
Red Hat Inc.
From 5970f2591734edba76c2d66a96016f32858e00fc Mon Sep 17 00:00:00 2001
From: Martin Kosek <mko...@redhat.com>
Date: Wed, 16 Oct 2013 15:30:04 +0200
Subject: [PATCH] Add direct bug reporting links to Feedback section

This change should enable faster and easier filing of new bugs. Patch
also simplifies the section for both redhat and fedora variants.

https://fedorahosted.org/freeipa/ticket/3754
---
 src/user_guide/en-US/Feedback.xml | 111 ++++++++++----------------------------
 1 file changed, 29 insertions(+), 82 deletions(-)

diff --git a/src/user_guide/en-US/Feedback.xml b/src/user_guide/en-US/Feedback.xml
index b79ec0ca3ec023f55728255d34e2514e6fefb5d1..4d36b3fd8554ddae9df6b0d5b2a8a817223494ac 100644
--- a/src/user_guide/en-US/Feedback.xml
+++ b/src/user_guide/en-US/Feedback.xml
@@ -3,86 +3,33 @@
 ]>
 
 <section id="feedback">
-	<title>Giving Feedback</title>
-	<para>
-		If there is any error in this book or there is any way to improve the
-		documentation, please let us know. Bugs can be filed against the documentation for &IPA; through
-		Bugzilla, <ulink url="http://bugzilla.redhat.com/bugzilla";>http://bugzilla.redhat.com/bugzilla</ulink>. Make the bug report as specific as
-		possible, so we can be more effective in correcting any issues:
-	</para>
-
-<!-- redhat specific instructions -->
-	<orderedlist condition="redhat">
-		<listitem>
-			<para>
-				Select the &RH; group and the &RHEL; &RVER; product.
-			</para>
-		</listitem>
-		<listitem>
-			<para>
-				Set the component to <command>&BOOKID;</command>.
-			</para>
-		</listitem>
-		<listitem>
-			<para>
-				For errors, give the page number (for the PDF) or URL (for the HTML), and give a
-				succinct description of the problem, such as incorrect procedure or typo.
-			</para>
-			<para>
-				For enhancements, put in what information needs to be added and why.
-			</para>
-		</listitem>
-		<listitem>
-			<para>
-				Give a clear title for the bug. For example, <command>"Incorrect command example for
-				setup script options"</command> is better than <command>"Bad example"</command>.
-			</para>
-		</listitem>
-	</orderedlist>
-	<para condition="redhat">
-		We appreciate receiving any feedback &mdash; requests for new sections, corrections, improvements, enhancements, even
-		new ways of delivering the documentation or new styles of docs. You are welcome to contact &RH; Content Services
-		directly at <ulink url="mailto:d...@redhat.com">d...@redhat.com</ulink>.
-	</para>
-<!-- end redhat -->
-
-
-<!-- fedora specific instructions -->
-	<orderedlist condition="fedora">
-		<listitem>
-			<para>
-				Select the Community group and the freeIPA product.
-			</para>
-		</listitem>
-		<listitem>
-			<para>
-				Set the component to Documentation.
-			</para>
-		</listitem>
-		<listitem>
-			<para>
-				Set the version number to &VER;.
-			</para>
-		</listitem>
-		<listitem>
-			<para>
-				For errors, give the page number (for the PDF) or URL (for the HTML), and give a
-				succinct description of the problem, such as incorrect procedure or typo.
-			</para>
-			<para>
-				For enhancements, put in what information needs to be added and why.
-			</para>
-		</listitem>
-		<listitem>
-			<para>
-				Give a clear title for the bug. For example, <command>"Incorrect command example for
-				setup script options"</command> is better than <command>"Bad example"</command>.
-			</para>
-		</listitem>
-	</orderedlist>
-	<para condition="fedora">
-		We appreciate receiving any feedback &mdash; requests for new sections, corrections, improvements, enhancements, even
-		new ways of delivering the documentation or new styles of docs. You are welcome to contact the Fedora docs team at <ulink url="mailto:d...@lists.fedoraproject.org">d...@lists.fedoraproject.org</ulink>.
-	</para>
-<!-- end fedora -->
+    <title>Giving Feedback</title>
+    <para>
+        If there is any error in this book or there is any way to improve the
+        documentation, please let us know. Make the bug report as specific as
+        possible, so we can be more effective in correcting any issues.
+    </para>
+    <para condition="fedora">
+        Bugs can be filed both to upstream &PROD;
+        <ulink url="https://fedorahosted.org/freeipa/";>Trac instance</ulink>,
+        by selecting a <command>Documentation</command> component
+        (<ulink url="https://fedorahosted.org/freeipa/newticket?component=Documentation";>direct
+        link</ulink>, requires logging in first), or to
+        <ulink url="http://bugzilla.redhat.com/";>Red Hat Bugzilla</ulink>,
+        by selecting a <command>freeipa</command> component
+        (<ulink url="https://bugzilla.redhat.com/enter_bug.cgi?bug_status=NEW&amp;component=freeipa&amp;form_name=enter_bug&amp;product=Fedora";>direct link</ulink>,
+        requires logging in first).
+    </para>
+    <para condition="redhat">
+        Bugs can be filed to
+        <ulink url="http://bugzilla.redhat.com/";>Red Hat Bugzilla</ulink>,
+        by selecting a <command>ipa</command> component
+        (<ulink url="https://bugzilla.redhat.com/enter_bug.cgi?bug_status=NEW&amp;component=ipa&amp;form_name=enter_bug&amp;product=Red%20Hat%20Enterprise%20Linux%206";>direct link</ulink>,
+        requires logging in first).
+    </para>
+    <para>
+        We appreciate receiving any feedback &mdash; requests for new sections,
+        corrections, improvements, enhancements, even new ways of delivering
+        the documentation or new styles of docs.
+    </para>
 </section>
-- 
1.8.3.1

_______________________________________________
Freeipa-devel mailing list
Freeipa-devel@redhat.com
https://www.redhat.com/mailman/listinfo/freeipa-devel

Reply via email to