Changeset 3304

Timestamp:

May 8, 2007, 10:04:14 AM (16 years ago)

Author:

Nicklas Nordborg

Message:

Fixes #517: Read resources section

File:

• trunk/doc/src/docbook/overviewdoc/resources.xml (modified) (9 diffs)

trunk/doc/src/docbook/overviewdoc/resources.xml

@@ -31 +31 @@
   <title>Resources</title>
   <para>
-    There are a couple of available resources for those who are using BASE2 or have some other
-    kind of interested in the BASE2 project. This chapter contains information about the
-    different resources that are available and also some short instructions on how to use each
+    There are several resources available for those who are using BASE 2 or have some other
+    kind of interested in the BASE 2 project. This chapter contains information about those
+    resources and also some short instructions on how to use each
     one of them.
   </para>
@@ -50 +50 @@
         The download page is accessed from the download section, on the home page, by
         following the link to
-        <ulink url='http://base.thep.lu.se/wiki/DownloadPage'>Download Page</ulink>
-        . The main-options on this page is to either download BASE 2 releases as a tar.gz
-        package or checkout the source code directly from repository. See the separate parts
-        on the web page to get more information how to proceed with each one of them.
+        <guilabel><ulink url='http://base.thep.lu.se/wiki/DownloadPage'
+          >Download Page</ulink></guilabel>. 
+        From this page you can download BASE 2 releases as packaged tar.gz
+        files or checkout the source code directly from the Subversion repository. 
+        See the separate parts on the web page to get more information how to 
+        proceed with each one of them.
+        
         <variablelist>
+          <varlistentry>
+            <term>Packaged BASE 2 releases</term>
+            <listitem>
+              <para>
+                Both source-packages and binary-packages are available for each release
+                of the program.
+              </para>
+            </listitem>
+          </varlistentry>
           <varlistentry>
             <term>Repository access</term>
@@ -65 +77 @@
                   <listitem>
                     <para>
-                      Bleeding edge of the software, which is the latest
-                      revision of the program. The code is not guaranteed to
-                      work correctly and it is recommended to backup important
-                      data in the database before updating.
+                      The latest production release. This will give you
+                      the same source code as one of the packaged
+                      releases.
                     </para>
                   </listitem>
                   <listitem>
                     <para>
-                      Latest production release that contains bug fixes (not
-                      fully tested) for the latest tagged release.
+                      The latest non-released bugfix branch. Use this if
+                      you are affected by a bug that has been fixed but not
+                      yet released. 
                     </para>
                   </listitem>
                   <listitem>
                     <para>
-                      The production release that was last tagged in
-                      subversion.
+                      Bleeding edge of the software, which is the latest
+                      revision of the program. The code is not guaranteed to
+                      work correctly and it is recommended to backup important
+                      data in the database before updating. Use this at your own
+                      risk, we can't guarantee that you will be able to upgrade
+                      the installation to another version or release.
                     </para>
                   </listitem>
@@ -87 +103 @@
             </listitem>
           </varlistentry>
-          <varlistentry>
-            <term>Packaged BASE 2 releases</term>
-            <listitem>
-              <para>
-                Those who don't want to get the source directly from repository can
-                instead choose to download BASE 2 in pre-compiled packages. Both
-                source-packages and binary-packages are available for each release
-                of the program.
-              </para>
-            </listitem>
-          </varlistentry>
         </variablelist>
       </para>
@@ -103 +108 @@
     <sect2 id="resources.home_page.tickets">
       <title>Ticket system</title>
-      <para>
-        There is a tool button on BASE 2's home-page, called
-        <ulink url="http://base.thep.lu.se/query">'View Tickets'</ulink>
-        This shows the list of tickets, only active tickets by default, for the
-        BASE-project. It is a good idea to have a look at this list before reporting a bug
+
+      <para>
+        A ticket is a note about a bug or a new feature that has not yet been
+        implemented. To show the list of outstanding tickets use the
+        <guibutton><ulink url="http://base.thep.lu.se/query"
+          >View Tickets</ulink></guibutton> button on BASE 2's home-page. 
+        It is a good idea to have a look at this list before reporting a bug
         or requesting a new feature. Perhaps someone has registered the issue as a ticket
         already. This list can also be used to see how the BASE 2 development is proceeding
@@ -114 +121 @@
 
       <para>
-        To report bugs, add feature requests, and comment an existing ticket, one needs to
-        be logged in to the trac environment. This is done by clicking on the login-link to
-        the right in the upper corner on the home page. The Feedback-section, also on the
-        home page, contains more information how to proceed.
-      </para>
-
-      <para>
-        The road map of BASE 2 is located on the Road map page, accessed with the toolbar
-        button with the same name. This page contains information about which tickets each
-        milestone covers and when it's due date is.
+        To report bugs, add feature requests, and comment an existing ticket, you needs to
+        be logged in to the trac environment. This is done by clicking on the 
+        <guilabel>login</guilabel>-link to
+        the right in the upper corner on the home page. The <guilabel>Feedback</guilabel>-section, 
+        also on the home page, contains more information how to proceed.
+      </para>
+    </sect2>
+    <sect2 id="resources.home_page.roadmap">
+      <title>Roadmap</title>
+
+      <para>
+        The roadmap of BASE 2 is accessed from the 
+        <guibutton><ulink url="http://base.thep.lu.se/roadmap"
+          >Roadmap</ulink></guibutton> button on the home page. This page 
+        contains information about the plans for future development, including
+        the tickets that should be fixed for each milestone. Usually, only
+        the next upcoming release has a date set. The <guilabel>BASE 2.x</guilabel>
+        milestone is used to collected tickets that we think should be fixed
+        but are less important or require too much work. Contributions are welcome.
       </para>
 
@@ -179 +195 @@
   </sect1>
   <sect1 id="resources.coreplugins">
-    <title>Available core plug-ins</title>
-    <para>
-      In the section called Plug-ins at on the start page, is a
+    <title>Core plug-in configurations</title>
+    <para>
+      In the section called <guilabel>Plug-ins</guilabel> at on the home page, is a
+      link to
       <ulink
         url="http://base.thep.lu.se/chrome/site/doc/admin/plugin_configuration/coreplugins.html">
-        link
-      </ulink>
-      to a page with available core plug-ins. All plugins that comes with the installation of
+        a page that lists the core plug-ins</ulink>.
+      All plug-ins that are included in the installation of
       BASE 2 are listed on this page, some together with one or several examples of suitable
       configuration files. These configuration files can be downloaded and imported with the
-      plugin-configuration importer in BASE 2.
+      plug-in configuration importer in BASE 2.
     </para>
   </sect1>
@@ -215 +231 @@
     <para>
       Use
-      <userinput>base2</userinput>
-      as user/login name together with the password
-      <userinput>base2</userinput>
+      <userinput>base2</userinput> as login and
+      <userinput>base2</userinput> as password
       to login to the demo server. The base2 user account has read privileges to all data on
-      the demo server and can view almost every list page. If extended privileges is wanted,
-      please contact the administrator of the demo server(see the bottom of the browser).
+      the demo server and can view almost every list page. If extended privileges are wanted,
+      please contact the administrator of the demo server (see the bottom of the browser).
     </para>
   </sect1>
@@ -266 +281 @@
     <important>
       <title>Mailing lists are still #1</title>
-      <para>Use the mailing lists to get in contact with the development-team.</para>
+      <para>Use the mailing lists to get in contact with the development team.</para>
     </important>
   </sect1>