[website] 01/01: Add a section to the policy about contributing to the policy

[Ross Gammon]

This is an automated email from the git hooks/post-receive script.

ross-guest pushed a commit to branch master
in repository website.

commit 5223410256c7e4dba3dbacbf5d9f7bf35743f4c7
Author: Ross Gammon <rossgammon at mail.dk>
Date:   Thu Dec 24 17:34:07 2015 +0100

    Add a section to the policy about contributing to the policy
---
 policy.xml | 54 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 54 insertions(+)

diff --git a/policy.xml b/policy.xml
index fc76b2d..0179190 100644
--- a/policy.xml
+++ b/policy.xml
@@ -186,6 +186,9 @@
           so that others can benefit.
           Please send any comments or ideas to
           <ulink url="mailto:debian-gis at lists.debian.org">debian-gis at lists.debian.org</ulink>.
+          For more details on contributing to the policy, see the
+          <link linkend="contributing">Contributing to the GIS Policy</link>
+          section later in the policy.
         </para>
       </sect3>
     </sect2>
@@ -2816,5 +2819,56 @@ clean-patched:
         </itemizedlist>
       </sect3>
     </sect2>
+    <sect2 id="contributing">
+      <title>Contributing to the GIS Policy</title>
+      <para>
+        As a member of the Debian GIS Team you will be able to commit modifications
+        to this policy. It would be wise to state your intentions on <ulink url="mailto:debian-gis at lists.debian.org">debian-gis at lists.debian.org</ulink>
+        first, and make sure there is general agreement on the proposed changes.
+      </para>
+      <para>
+        The source for the Debian GIS Policy can be downloaded from the same repository
+        as all the GIS packages:
+<programlisting>
+<command>debcheckout</command> <option>--user</option> <replaceable><username></replaceable> git://git.debian.org/pkg-grass/website.git <option>--git-track <replaceable>'*'</replaceable></option>
+</programlisting>
+      </para>
+      <para>
+        To update the policy, you need to edit the <filename class="directory">policy.xml</filename>
+        file. The website uses the Docbook XML syntax. If you copy the style
+        used in the rest of the document, you will probably have no problems.
+        Further information about the Docbook XML syntax can be found documented
+        on the <ulink url="http://www.docbook.org/tdg/en/html/">Docbook</ulink>
+        website.
+      </para>
+      <para>
+        The policy in particular makes use of <programlisting>, <command>,
+        <option> tags, and lists package names using <literal> tags.
+      </para>
+      <para>
+        The maximum length of paragraph content is 80 characters, and XML children are
+        indented with 2 spaces.
+      </para>
+      <para>
+        After making changes to the <filename class="directory">policy.xml</filename>
+        file it's highly recommended to run <command>make</command> which will validate
+        the XML syntax using xmllint before generating the HTML. Make sure you have the
+        <literal>xsltproc</literal> package installed for the 'make' command not to fail.
+      </para>
+      <para>
+        If there are no errors, commit your changes and push them to the Alioth
+        git repository. Alternatively, create a patch and send it to the
+        <ulink url="mailto:debian-gis at lists.debian.org">debian-gis at lists.debian.org</ulink>
+        mailing list for comments.
+      </para>
+      <para>
+		Run the <command>git status</command> command to check if there are any stray files.
+		If there are none, update the policy online (which is included in pkg-grass website
+		on Alioth) using <command>make publish</command>. This will rsync the current working
+		directory to the team webspace on Alioth and fix the group permissions. There are
+		currently problems with the icons directory on Alioth (which is owned by frankie)
+		but this does not cause problems for normal updates.
+	  </para>
+    </sect2>
   </sect1>
 </article>

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-grass/website.git