2016-04-12 11:38 GMT+02:00 Luca Toscano <[email protected]>:
> Hi docs@!
>
> I have been thinking a way to inform users about our best practices when
> finding inconsistencies in the docs, namely checking CHANGES and Bugzilla
> first. Most of the times occasional users (or even experienced ones) tend
> to forget where the changelog is, if httpd uses bugzilla or not, etc.. so
> it would be great in my opinion to add a "reminder" in our manual pages.
> The attached patch will add a little section in the right column (right
> below "See also") to provide the aforementioned links.
>
> Position, wording, etc.. can be changed of course, this email is only
> meant to discuss the idea. If you don't like it, just state it out loud and
> I'll drop it :)
>
> Let me know your thoughts!
>
> Luca
>
>
Restarted from the first email to avoid a quoting mess. I attached the
final patch that would basically add the "Bugfix checklist" section before
"see also" on each module's page. I wanted to restrict the scope of this
patch to the places in which occasional users will benefit more rather than
adding it to the whole documentation.
Christophe, André, Rich: if you want to review the patch it would be really
great. If anybody feels very strong against it I'll drop it.
Thanks!
Luca
Index: docs/manual/style/lang/da.xml
===================================================================
--- docs/manual/style/lang/da.xml (revision 1739811)
+++ docs/manual/style/lang/da.xml (working copy)
@@ -72,6 +72,7 @@
<message id="uppercase">ABCDEFGHIJKLMNOPQRSTUVWXYZ曝�</message>
<message id="name-section">NAVN</message>
<message id="hyphenation"></message>
+ <message id="foundabug">Bugfix checklist:</message>
<!-- Used in description box for directives -->
<message id="syntax">Syntaks</message>
Index: docs/manual/style/lang/de.xml
===================================================================
--- docs/manual/style/lang/de.xml (revision 1739811)
+++ docs/manual/style/lang/de.xml (working copy)
@@ -67,6 +67,7 @@
<message id="uppercase">ABCDEFGHIJKLMNOPQRSTUVWXYZ</message>
<message id="name-section">NAME</message>
<message id="hyphenation"></message>
+ <message id="foundabug">Bugfix checklist:</message>
<!-- Used in description box for directives -->
<message id="syntax">Syntax</message>
Index: docs/manual/style/lang/en.xml
===================================================================
--- docs/manual/style/lang/en.xml (revision 1739811)
+++ docs/manual/style/lang/en.xml (working copy)
@@ -71,6 +71,7 @@
<message id="uppercase">ABCDEFGHIJKLMNOPQRSTUVWXYZ</message>
<message id="name-section">NAME</message>
<message id="hyphenation"></message>
+ <message id="foundabug">Bugfix checklist:</message>
<!-- Used in description box for directives -->
<message id="syntax">Syntax</message>
Index: docs/manual/style/lang/es.xml
===================================================================
--- docs/manual/style/lang/es.xml (revision 1739811)
+++ docs/manual/style/lang/es.xml (working copy)
@@ -69,6 +69,7 @@
<message id="uppercase">ABCDEFGHIJKLMN��OPQRSTUVWXYZ</message>
<message id="name-section">Nombre</message>
<message id="hyphenation">Cesura</message>
+ <message id="foundabug">Bugfix checklist:</message>
<!-- Used in description box for directives -->
<message id="syntax">Sintaxis</message>
Index: docs/manual/style/lang/fr.xml
===================================================================
--- docs/manual/style/lang/fr.xml (revision 1739811)
+++ docs/manual/style/lang/fr.xml (working copy)
@@ -71,6 +71,7 @@
<message id="uppercase">ABCDEFGHIJKLMNOPQRSTUVWXYZ</message>
<message id="name-section">NOM</message>
<message id="hyphenation">Césure</message>
+ <message id="foundabug">Bugfix checklist:</message>
<!-- Used in description box for directives -->
<message id="syntax">Syntaxe</message>
Index: docs/manual/style/lang/ja.xml
===================================================================
--- docs/manual/style/lang/ja.xml (revision 1739811)
+++ docs/manual/style/lang/ja.xml (working copy)
@@ -66,6 +66,7 @@
<message id="uppercase">ABCDEFGHIJKLMNOPQRSTUVWXYZ</message>
<message id="name-section">NAME</message>
<message id="hyphenation"></message>
+ <message id="foundabug">Bugfix checklist:</message>
<!-- Used in description box for directives -->
<message id="syntax">妲����</message>
Index: docs/manual/style/lang/ko.xml
===================================================================
--- docs/manual/style/lang/ko.xml (revision 1739811)
+++ docs/manual/style/lang/ko.xml (working copy)
@@ -72,6 +72,7 @@
<message id="uppercase">ABCDEFGHIJKLMNOPQRSTUVWXYZ</message>
<message id="name-section">NAME</message>
<message id="hyphenation"></message>
+ <message id="foundabug">Bugfix checklist:</message>
<!-- Used in description box for directives -->
<message id="syntax">巩过</message>
Index: docs/manual/style/lang/pt-br.xml
===================================================================
--- docs/manual/style/lang/pt-br.xml (revision 1739811)
+++ docs/manual/style/lang/pt-br.xml (working copy)
@@ -70,6 +70,7 @@
<!-- Used in manualpage -->
<message id="relatedmodules">Módulos Relacionados</message>
<message id="relateddirectives">Diretrizes Relacionadas</message>
+ <message id="foundabug">Bugfix checklist:</message>
<!-- Used in description box for directives -->
<message id="syntax">Sintaxe</message>
Index: docs/manual/style/lang/ru.xml
===================================================================
--- docs/manual/style/lang/ru.xml (revision 1739811)
+++ docs/manual/style/lang/ru.xml (working copy)
@@ -70,6 +70,7 @@
<message id="uppercase">ABCDEFGHIJKLMNOPQRSTUVWXYZ</message>
<message id="name-section">NAME</message>
<message id="hyphenation"></message>
+ <message id="foundabug">Bugfix checklist:</message>
<!-- Used in description box for directives -->
<message id="syntax">笊卧了由�</message>
Index: docs/manual/style/lang/tr.xml
===================================================================
--- docs/manual/style/lang/tr.xml (revision 1739811)
+++ docs/manual/style/lang/tr.xml (working copy)
@@ -73,6 +73,7 @@
<message id="uppercase">ABC��DEFG��HI陌JKLMNO��PQRS��TU��VWXYZ</message>
<message id="name-section">陌S陌M</message>
<message id="hyphenation">.nh</message>
+ <message id="foundabug">Bugfix checklist:</message>
<!-- Used in description box for directives -->
<message id="syntax">S枚zdizimi</message>
Index: docs/manual/style/lang/zh-cn.xml
===================================================================
--- docs/manual/style/lang/zh-cn.xml (revision 1739811)
+++ docs/manual/style/lang/zh-cn.xml (working copy)
@@ -69,6 +69,7 @@
<message id="uppercase">ABCDEFGHIJKLMNOPQRSTUVWXYZ</message>
<message id="name-section">���绉�</message>
<message id="hyphenation"></message>
+ <message id="foundabug">Bugfix checklist:</message>
<!-- Used in description box for directives -->
<message id="syntax">璇�娉�</message>
Index: docs/manual/style/xsl/synopsis.xsl
===================================================================
--- docs/manual/style/xsl/synopsis.xsl (revision 1739811)
+++ docs/manual/style/xsl/synopsis.xsl (working copy)
@@ -244,6 +244,16 @@
</xsl:choose>
</xsl:if> <!-- /!is-chm -->
+ <h3>
+ <xsl:value-of select="$message[@id='foundabug']" />
+ </h3>
+ <ul class="seealso">
+ <li><a
href="http://httpd.apache.org/dev/dist/CHANGES_2.4";>
+ httpd 2.4 Changelog</a></li>
+ <li><a href="https://bz.apache.org/bugzilla/query.cgi";>
+ httpd Bugzilla</a></li>
+ </ul>
+
<xsl:if test="seealso">
<h3>
<xsl:value-of select="$message
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
