[gimp-help/gimp-help-2-10] web: update the help and about pages a bit



commit dae3aad0e5d3654983d1634d26531db323cbe1d4
Author: Jacob Boerema <jgboerema gmail com>
Date:   Mon Mar 7 17:31:24 2022 -0500

    web: update the help and about pages a bit

 web/about.xml |  20 ++++-----
 web/help.xml  | 139 ++++++++++++++++++++++++++++++++++++++++++----------------
 2 files changed, 112 insertions(+), 47 deletions(-)
---
diff --git a/web/about.xml b/web/about.xml
index 3533b9e62..3aac4942b 100644
--- a/web/about.xml
+++ b/web/about.xml
@@ -1,5 +1,5 @@
 <?xml version='1.0' encoding="UTF-8" ?>
-<!DOCTYPE webpage PUBLIC "-//Norman Walsh//DTD Website V2.5.0//EN" 
+<!DOCTYPE webpage PUBLIC "-//Norman Walsh//DTD Website V2.5.0//EN"
           "website.dtd" >
 <webpage id="about">
 
@@ -9,23 +9,23 @@
   </head>
 
   <section>
-    <title>What's this page about?</title>
+    <title>Introduction</title>
 
     <para>
-      The task of the documentation team is the writing of a new manual
-      for current and future generations of <ulink
-        url='https://www.gimp.org'>GIMP</ulink>. The GIMP User Manual is
-      a newly written User Manual, written for the GIMP Help Browser,
-      but able to produce the Help pages for other media as well.
+      The docs.gimp.org website provides access to the user manual for
+      <ulink url='https://www.gimp.org'>GIMP</ulink>. Our documentation is
+      available both for <ulink url='index.html#gimp210-online'>online</ulink>
+      and <ulink url='index.html#gimp210-offline'>offline</ulink> use.
     </para>
   </section>
 
   <section>
-    <title>Goals?</title>
+    <title>Goal</title>
 
     <para>
-      Our goal is to provide a multilingual user manual for <ulink
-        url='https://www.gimp.org'>GIMP</ulink>.
+      The goal of the GIMP documentation team is improving and updating the
+      user manual for current and future versions of GIMP, and providing
+      new and improved translations.
     </para>
   </section>
 </webpage>
diff --git a/web/help.xml b/web/help.xml
index 7773c09b5..7e4411407 100644
--- a/web/help.xml
+++ b/web/help.xml
@@ -1,5 +1,5 @@
 <?xml version='1.0' encoding="UTF-8" ?>
-<!DOCTYPE webpage PUBLIC "-//Norman Walsh//DTD Website V2.5.0//EN" 
+<!DOCTYPE webpage PUBLIC "-//Norman Walsh//DTD Website V2.5.0//EN"
           "website.dtd" >
 <webpage id="help">
 
@@ -9,52 +9,117 @@
   </head>
 
   <section>
-    <title>How to get involved</title> 
+    <title>Introduction</title>
 
-    <para class="Flattr">
-      <?dbhtml-include href="includes/flattr.html" ?>
-    </para>
     <para>
-      Helping us is very easy. Get a working copy of the code and join
-      our mailing list. Feel free to make changes on your working copy
-      and feel free to tell us where you'd like to help.
+      There are several ways in which you get involved by helping us improve
+      GIMP's documentation.
     </para>
-
     <orderedlist>
-     <listitem>
-       <para>Create a local working copy of gimp-help for yourself.</para>
-       <para>
-         <programlisting>
-           <![CDATA[
-           $ git clone git gitlab gnome org:GNOME/gimp-help.git
-           ]]>
-         </programlisting>
-       </para>
-     </listitem>
-     <listitem>
-       <para>
-         Join our mailinglist at: <ulink
-           url='https://mail.gnome.org/mailman/listinfo/gimp-docs-list'
-           />
-       </para>
+      <listitem>
+        <para>
+          <ulink url='#translate'>Translate</ulink> the User Manual.
+        </para>
+      </listitem>
+      <listitem>
+        <para>
+          Write new or improved <ulink url='#content'>content</ulink> for the
+          User Manual.
+        </para>
       </listitem>
-     <listitem>
-       <para>
-         You can check the GNOME bug tracker in order to contribute patches:
-         <ulink
-           url='https://gitlab.gnome.org/GNOME/gimp-help/issues'
-           />
-       </para>
+      <listitem>
+        <para>
+          Write <ulink url='https://www.gimp.org/tutorials/'>tutorials</ulink>
+          for the website.
+        </para>
+      </listitem>
+      <listitem>
+        <para>
+          Give feedback on the current User Manual and
+          <ulink url='https://gitlab.gnome.org/GNOME/gimp-help/issues'>
+          report</ulink> incorrect or missing documentation.
+        </para>
       </listitem>
     </orderedlist>
+
+    <note>
+      <para>
+        More information on helping out with GIMP in general is available
+        <ulink url='https://www.gimp.org/develop/'>here</ulink>.
+      </para>
+    </note>
   </section>
 
-  <section>
-    <title>Current Progress</title>
+  <section id="translate">
+    <title>Translating</title>
+    <para>
+      If you are interested in translating the manual the best way to start is
+      going to <ulink url="https://l10n.gnome.org/module/gimp-help/";
+      title="Damned Lies">Damned Lies</ulink>, register an account and apply to
+      be a member of the language team for the language you want to translate.
+      You can then start translating the po files of GIMP's manual found
+      on that website.
+    </para>
+    <para>
+      The current progress of each translation can be found on our
+      <ulink url='index.html#gimp210-online'>main page</ulink>.
+      Detailed information about the progress for each separate file is
+      available on the already mentioned
+      <ulink url="https://l10n.gnome.org/module/gimp-help/";>gimp-help</ulink>
+      page of Damned Lies.
+    </para>
+    <para>
+      If your language isn't listed yet as being translated, then please
+      contact us on
+      <ulink url='https://www.gimp.org/discuss/'>IRC or the relevant
+      mailing lists</ulink>. We will then add your language and shortly after
+      the relevant files to translate will turn up on Damned Lies.
+    </para>
+  </section>
+
+  <section id="content">
+    <title>Improving the User Manual</title>
+    <para>
+      If you would like to help out writing and improving our documentation,
+      then our <ulink url='https://gitlab.gnome.org/GNOME/gimp-help'>gimp-help</ulink>
+      repository is the right place to start.
+    </para>
+    <para>
+      Preferrably you build the most up to date manual yourself, or check
+      the latest <ulink url='https://docs.gimp.org/2.10/en/'>online version</ulink>.
+      The source of the manual can be found in XML files in the
+      <ulink url='https://gitlab.gnome.org/GNOME/gimp-help/-/tree/master/src'>/src</ulink>
+      directory. Find a topic that interests you or that needs updating and
+      start writing.
+    </para>
+    <para>
+      You could also take a look at our
+      <ulink url='https://gitlab.gnome.org/GNOME/gimp-help/issues'>issue tracker</ulink>
+      to see which documentation issues you can help with.
+    </para>
+    <para>
+      Our User Manual is written in Docbook XML files. Some knowledge of
+      Docbook and XML in general is useful, but if you look at the structure
+      of the documents that are already written, it should not be too
+      difficult. If you are uncertain about something, you can always ask, see
+      the links below on how to contact us.
+    </para>
+    <para>
+      It would be a good idea to subscribe to some of GIMP's
+      <ulink url='https://www.gimp.org/discuss.html#mailing-lists'>mailing lists</ulink>,
+      especially the developer and docs lists. That way you can keep up to date
+      about the development of GIMP.
+      Most of the GIMP developers can also be reached on the
+      <ulink url='https://www.gimp.org/discuss.html#irc-matrix'>#gimp IRC channel</ulink>
+      on irc.gimp.org. The best chances to talk are usually during European
+      evening hours, but be patient, getting an answer can take a while. Note
+      that there is no need to ask if you can ask a question: just ask.
+    </para>
     <para>
-      To find out about the current progress of each translation use
-      <ulink url="https://l10n.gnome.org/module/gimp-help/";
-        title="Damned Lies">Damned Lies</ulink>.
+      Before you can send us your changes you should have a Gnome Gitlab
+      account and fork the gimp-help repository. For each new issue you work
+      on, please make a separate branch. When ready push your changes to
+      your branch and then open a MR (merge request).
     </para>
   </section>
 


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]