Ignore:
Timestamp:
Apr 19, 2007, 4:27:32 PM (15 years ago)
Author:
Martin Svensson
Message:

References #517. More text to the resources-chapter

File:
1 edited

Legend:

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

    r3251 r3255  
    3232  <para>
    3333    There are some available resources for those who are using BASE2 or have some other kind of
    34     interested in the BASE2 project. This chapter has information about the different resources
    35     that are available and some short instructions how each one of them could/should be used.
     34    interested in the BASE2 project. This chapter contains information about these different
     35    resources that are available and also some short instructions how use each one of them.
    3636  </para>
    37   <sect1 id="home_page">
     37  <sect1 id="resources.home_page">
    3838    <title>Home page</title>
    39     <para></para>
    40     <sect2 id="download">
     39    <para>
     40      The home page of BASE 2 is located at:
     41      <ulink url='http://base.thep.lu.se'>http://base.thep.lu.se</ulink>
     42      . Here is alot of useful information about the project and the program, e.g.
     43      documentation/manuals, download-pages, contact information and much more. The most
     44      important parts of the page are covered in this section.
     45    </para>
     46    <sect2 id="resources.home_page.download">
    4147      <title>Download</title>
    42       <para></para>
     48      <para>
     49        The download page is accessed from the download section, on the home page, by
     50        following the link to
     51        <ulink url='http://base.thep.lu.se/wiki/DownloadPage'>DownloadPage</ulink>
     52        . The main-options on this page is to either download BASE 2 releases as a tar.gz
     53        package or checkout the source code directly from repository. See the seperate parts
     54        on the web page to get more information how to proceed in each one of them.
     55        <variablelist>
     56          <title>Download options</title>
     57          <varlistentry>
     58            <term>Repository access</term>
     59            <listitem>
     60              <para>
     61                With this option the visitor can get the source code directly from
     62                Subversion. There are at least three different version that are
     63                possible to checkout from repository.
     64                <itemizedlist>
     65                  <listitem>
     66                    <para>
     67                      Bleeding edge of the software, which is the latest
     68                      revision of the program. The code is not guranteed to
     69                      work correctly and it is recommended to backup important
     70                      data in the database before updating to this checked out
     71                      version.
     72                    </para>
     73                  </listitem>
     74                  <listitem>
     75                    <para>
     76                      Latest production release that contains bug fixes (not
     77                      fully tested) for the latest tagged release.
     78                    </para>
     79                  </listitem>
     80                  <listitem>
     81                    <para>
     82                      The production release that was last tagged in
     83                      subversion.
     84                    </para>
     85                  </listitem>
     86                </itemizedlist>
     87              </para>
     88            </listitem>
     89          </varlistentry>
     90          <varlistentry>
     91            <term>Packaged BASE 2 releases</term>
     92            <listitem>
     93              <para>
     94                Those who don't want to get the source directly from repository can
     95                instead choose to download BASE 2 in pre-compiled packages. Both
     96                source-packages and binary-packages are available for each release
     97                of the program.
     98              </para>
     99            </listitem>
     100          </varlistentry>
     101        </variablelist>
     102      </para>
    43103    </sect2>
    44     <sect2 id="tickets">
     104    <sect2 id="resources.home_page.tickets">
    45105      <title>Ticket system</title>
    46       <para></para>
     106      <para>
     107        There is a toolbutton on BASE 2's home-page, called
     108        <ulink url="http://base.thep.lu.se/query">'View Tickets'</ulink>
     109        This will show the list of tickets, by default only active tickets, for the
     110        BASE-project. It is a good idea to have a look at this list before reporting a bug
     111        or requesting a new feature. Perhaps someone has registred the issue as a ticket
     112        already. This list can also be used to see how the BASE 2 development is proceeding
     113        and when some particular request is planed to be fixed.
     114      </para>
     115
     116      <para>
     117        To report bugs, add feature requests, and comment an existing ticket, one needs to
     118        be logged in to the trac enviroment. This is done by clicking on the login-link to
     119        the right in the upper corner on home page. The Feeback-section on start page
     120        contains more information how to proceed.
     121      </para>
     122
     123      <para>
     124        The road map of BASE 2 is located on the Road map page, accessed with the toolbar
     125        button with the same name. This page contains information about the different
     126        milestones covers and when their due date is.
     127      </para>
     128
    47129    </sect2>
    48     <sect2 id="coreplugins">
    49       <title>Available core plug-ins</title>
    50       <para></para>
    51     </sect2>
    52     <sect2 id="plugins">
    53       <title>BASE plug-ins site</title>
    54       <para></para>
    55     </sect2>
    56     <sect2 id="documentation">
     130    <sect2 id="resources.home_page.documentation">
    57131      <title>Documentation</title>
    58       <para></para>
     132      <para>
     133        All documentation that are associated with the project can be found in the
     134        Documentation-section on the start page.
     135        <variablelist>
     136          <varlistentry>
     137            <term>Manuals</term>
     138            <listitem>
     139              <para>
     140                Usefull information for the common user and the administrator, like
     141                user documentation, installation instructions and administration
     142                guide. These will be eventually be replaced with this document when
     143                it includes the corresponding texts.
     144              </para>
     145            </listitem>
     146          </varlistentry>
     147          <varlistentry>
     148            <term>Specifications</term>
     149            <listitem>
     150              <para>
     151                This part contains specification for the seperate divisions of the
     152                project, such as core specification, web-client specification and
     153                more.
     154              </para>
     155            </listitem>
     156          </varlistentry>
     157          <varlistentry>
     158            <term>Developer information</term>
     159            <listitem>
     160              <para>
     161                Information for those who are interested to be involved in the
     162                development of BASE 2.
     163              </para>
     164            </listitem>
     165          </varlistentry>
     166        </variablelist>
     167      </para>
    59168    </sect2>
    60169  </sect1>
    61   <sect1 id="demo_server">
     170  <sect1 id="resources.coreplugins">
     171    <title>Available core plug-ins</title>
     172    <para></para>
     173  </sect1>
     174  <sect1 id="resources.plugins">
     175    <title>BASE plug-ins site</title>
     176    <para></para>
     177  </sect1>
     178  <sect1 id="resources.demo_server">
    62179    <title>Demo server</title>
    63180    <para></para>
    64181  </sect1>
    65   <sect1 id="mailing_lists">
     182  <sect1 id="resources.mailing_lists">
    66183    <title>Mailing lists</title>
    67184    <para></para>
    68185  </sect1>
    69   <sect1 id="irc_channel">
     186  <sect1 id="resources.irc_channel">
    70187    <title>IRC channel</title>
    71188    <para></para>
Note: See TracChangeset for help on using the changeset viewer.