Documentation: use 'warning' tags

mantisbt · Apr 5, 2015 · 2191daa · 2191daa
1 parent 5ca2fb6
commit 2191daa
Show file tree

Hide file tree

Showing 4 changed files with 29 additions and 12 deletions.
diff --git a/docbook/Admin_Guide/en-US/Installation.xml b/docbook/Admin_Guide/en-US/Installation.xml
@@ -619,10 +619,14 @@ tar -xf <emphasis>filename.tar</emphasis>
 			as a starting point.
 		</para>
 
-		<para>WARNING: you should never edit the
-			<emphasis>config_defaults_inc.php</emphasis> file
-			directly, as it could cause issues with future upgrades.
-		</para>
+		<warning>
+			<para>you should never edit the
+				<emphasis>config_defaults_inc.php</emphasis> file
+				directly, as it could cause issues with future upgrades.
+				Always store your custom configuration in your own
+				<emphasis>config_inc.php</emphasis> file.
+			</para>
+		</warning>
 
 	</section>
 

diff --git a/docbook/Admin_Guide/en-US/config/misc.xml b/docbook/Admin_Guide/en-US/config/misc.xml
@@ -218,11 +218,18 @@
 		<varlistentry>
 			<term>$g_set_configuration_threshold</term>
 			<listitem>
-				<para>Threshold for users to set the system configurations generically via MantisBT web interface.
-					WARNING: Users who have access to set configuration via the interface MUST be trusted.  This is due
-					to the fact that such users can set configurations to PHP code and hence there can be a security
-					risk if such users are not trusted. The default value is ADMINISTRATOR.
+				<para>Threshold for users to set the system configurations
+					generically via MantisBT web interface.
+					The default value is ADMINISTRATOR.
 				</para>
+				<warning>
+					<para>Users who have access to set configuration via the
+						interface MUST be trusted. This is due to the fact that
+						these users can leverage the interface to
+						<emphasis>inject PHP code</emphasis> into the system,
+						which is a potential security risk.
+					</para>
+				</warning>
 			</listitem>
 		</varlistentry>
 		<varlistentry>

diff --git a/docbook/Admin_Guide/en-US/config/security.xml b/docbook/Admin_Guide/en-US/config/security.xml
@@ -35,7 +35,7 @@
 					the value of this configuration option.
 				</para>
 				<warning>
-					<para>WARNING: This configuration option has a profound
+					<para>This configuration option has a profound
 						impact on the security of your MantisBT
 						installation. Failure to set this configuration
 						option correctly could lead to your MantisBT

diff --git a/docbook/Admin_Guide/en-US/config/webserver.xml b/docbook/Admin_Guide/en-US/config/webserver.xml
@@ -35,7 +35,10 @@
 			<listitem>
 				<para>Use Session validation (defaults to <emphasis>ON</emphasis>)
 				</para>
-				<para><emphasis>WARNING: Disabling this could be a potential security risk</emphasis></para>
+				<warning>
+					<para>Disabling this could be a potential security risk !
+					</para>
+				</warning>
 			</listitem>
 		</varlistentry>
 
@@ -48,8 +51,11 @@
 				Some proxy servers may not correctly work with this option enabled
 				because they cache pages incorrectly.
 				</para>
-				<para><emphasis>WARNING: Disabling this option is a security risk,
-				it is strongly recommended to leave it ON</emphasis></para>
+				<warning>
+					<para>Disabling this option is a security risk,
+						it is strongly recommended to leave it ON
+					</para>
+				</warning>
 			</listitem>
 		</varlistentry>