Changeset 3304


Ignore:
Timestamp:
May 8, 2007, 10:04:14 AM (14 years ago)
Author:
Nicklas Nordborg
Message:

Fixes #517: Read resources section

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/doc/src/docbook/overviewdoc/resources.xml

    r3301 r3304  
    3131  <title>Resources</title>
    3232  <para>
    33     There are a couple of available resources for those who are using BASE2 or have some other
    34     kind of interested in the BASE2 project. This chapter contains information about the
    35     different resources that are available and also some short instructions on how to use each
     33    There are several resources available for those who are using BASE 2 or have some other
     34    kind of interested in the BASE 2 project. This chapter contains information about those
     35    resources and also some short instructions on how to use each
    3636    one of them.
    3737  </para>
     
    5050        The download page is accessed from the download section, on the home page, by
    5151        following the link to
    52         <ulink url='http://base.thep.lu.se/wiki/DownloadPage'>Download Page</ulink>
    53         . The main-options on this page is to either download BASE 2 releases as a tar.gz
    54         package or checkout the source code directly from repository. See the separate parts
    55         on the web page to get more information how to proceed with each one of them.
     52        <guilabel><ulink url='http://base.thep.lu.se/wiki/DownloadPage'
     53          >Download Page</ulink></guilabel>.
     54        From this page you can download BASE 2 releases as packaged tar.gz
     55        files or checkout the source code directly from the Subversion repository.
     56        See the separate parts on the web page to get more information how to
     57        proceed with each one of them.
     58       
    5659        <variablelist>
     60          <varlistentry>
     61            <term>Packaged BASE 2 releases</term>
     62            <listitem>
     63              <para>
     64                Both source-packages and binary-packages are available for each release
     65                of the program.
     66              </para>
     67            </listitem>
     68          </varlistentry>
    5769          <varlistentry>
    5870            <term>Repository access</term>
     
    6577                  <listitem>
    6678                    <para>
    67                       Bleeding edge of the software, which is the latest
    68                       revision of the program. The code is not guaranteed to
    69                       work correctly and it is recommended to backup important
    70                       data in the database before updating.
     79                      The latest production release. This will give you
     80                      the same source code as one of the packaged
     81                      releases.
    7182                    </para>
    7283                  </listitem>
    7384                  <listitem>
    7485                    <para>
    75                       Latest production release that contains bug fixes (not
    76                       fully tested) for the latest tagged release.
     86                      The latest non-released bugfix branch. Use this if
     87                      you are affected by a bug that has been fixed but not
     88                      yet released.
    7789                    </para>
    7890                  </listitem>
    7991                  <listitem>
    8092                    <para>
    81                       The production release that was last tagged in
    82                       subversion.
     93                      Bleeding edge of the software, which is the latest
     94                      revision of the program. The code is not guaranteed to
     95                      work correctly and it is recommended to backup important
     96                      data in the database before updating. Use this at your own
     97                      risk, we can't guarantee that you will be able to upgrade
     98                      the installation to another version or release.
    8399                    </para>
    84100                  </listitem>
     
    87103            </listitem>
    88104          </varlistentry>
    89           <varlistentry>
    90             <term>Packaged BASE 2 releases</term>
    91             <listitem>
    92               <para>
    93                 Those who don't want to get the source directly from repository can
    94                 instead choose to download BASE 2 in pre-compiled packages. Both
    95                 source-packages and binary-packages are available for each release
    96                 of the program.
    97               </para>
    98             </listitem>
    99           </varlistentry>
    100105        </variablelist>
    101106      </para>
     
    103108    <sect2 id="resources.home_page.tickets">
    104109      <title>Ticket system</title>
    105       <para>
    106         There is a tool button on BASE 2's home-page, called
    107         <ulink url="http://base.thep.lu.se/query">'View Tickets'</ulink>
    108         This shows the list of tickets, only active tickets by default, for the
    109         BASE-project. It is a good idea to have a look at this list before reporting a bug
     110
     111      <para>
     112        A ticket is a note about a bug or a new feature that has not yet been
     113        implemented. To show the list of outstanding tickets use the
     114        <guibutton><ulink url="http://base.thep.lu.se/query"
     115          >View Tickets</ulink></guibutton> button on BASE 2's home-page.
     116        It is a good idea to have a look at this list before reporting a bug
    110117        or requesting a new feature. Perhaps someone has registered the issue as a ticket
    111118        already. This list can also be used to see how the BASE 2 development is proceeding
     
    114121
    115122      <para>
    116         To report bugs, add feature requests, and comment an existing ticket, one needs to
    117         be logged in to the trac environment. This is done by clicking on the login-link to
    118         the right in the upper corner on the home page. The Feedback-section, also on the
    119         home page, contains more information how to proceed.
    120       </para>
    121 
    122       <para>
    123         The road map of BASE 2 is located on the Road map page, accessed with the toolbar
    124         button with the same name. This page contains information about which tickets each
    125         milestone covers and when it's due date is.
     123        To report bugs, add feature requests, and comment an existing ticket, you needs to
     124        be logged in to the trac environment. This is done by clicking on the
     125        <guilabel>login</guilabel>-link to
     126        the right in the upper corner on the home page. The <guilabel>Feedback</guilabel>-section,
     127        also on the home page, contains more information how to proceed.
     128      </para>
     129    </sect2>
     130    <sect2 id="resources.home_page.roadmap">
     131      <title>Roadmap</title>
     132
     133      <para>
     134        The roadmap of BASE 2 is accessed from the
     135        <guibutton><ulink url="http://base.thep.lu.se/roadmap"
     136          >Roadmap</ulink></guibutton> button on the home page. This page
     137        contains information about the plans for future development, including
     138        the tickets that should be fixed for each milestone. Usually, only
     139        the next upcoming release has a date set. The <guilabel>BASE 2.x</guilabel>
     140        milestone is used to collected tickets that we think should be fixed
     141        but are less important or require too much work. Contributions are welcome.
    126142      </para>
    127143
     
    179195  </sect1>
    180196  <sect1 id="resources.coreplugins">
    181     <title>Available core plug-ins</title>
    182     <para>
    183       In the section called Plug-ins at on the start page, is a
     197    <title>Core plug-in configurations</title>
     198    <para>
     199      In the section called <guilabel>Plug-ins</guilabel> at on the home page, is a
     200      link to
    184201      <ulink
    185202        url="http://base.thep.lu.se/chrome/site/doc/admin/plugin_configuration/coreplugins.html">
    186         link
    187       </ulink>
    188       to a page with available core plug-ins. All plugins that comes with the installation of
     203        a page that lists the core plug-ins</ulink>.
     204      All plug-ins that are included in the installation of
    189205      BASE 2 are listed on this page, some together with one or several examples of suitable
    190206      configuration files. These configuration files can be downloaded and imported with the
    191       plugin-configuration importer in BASE 2.
     207      plug-in configuration importer in BASE 2.
    192208    </para>
    193209  </sect1>
     
    215231    <para>
    216232      Use
    217       <userinput>base2</userinput>
    218       as user/login name together with the password
    219       <userinput>base2</userinput>
     233      <userinput>base2</userinput> as login and
     234      <userinput>base2</userinput> as password
    220235      to login to the demo server. The base2 user account has read privileges to all data on
    221       the demo server and can view almost every list page. If extended privileges is wanted,
    222       please contact the administrator of the demo server(see the bottom of the browser).
     236      the demo server and can view almost every list page. If extended privileges are wanted,
     237      please contact the administrator of the demo server (see the bottom of the browser).
    223238    </para>
    224239  </sect1>
     
    266281    <important>
    267282      <title>Mailing lists are still #1</title>
    268       <para>Use the mailing lists to get in contact with the development-team.</para>
     283      <para>Use the mailing lists to get in contact with the development team.</para>
    269284    </important>
    270285  </sect1>
Note: See TracChangeset for help on using the changeset viewer.