source: trunk/doc/src/docbook/overviewdoc/resources.xml @ 3291

Last change on this file since 3291 was 3291, checked in by Jari Häkkinen, 14 years ago

Minor changes.

File size: 10.0 KB
1<?xml version="1.0" encoding="UTF-8"?>
3    "-//Dawid Weiss//DTD DocBook V3.1-Based Extension for XML and graphics inclusion//EN"
4    "../../../../lib/docbook/preprocess/dweiss-docbook-extensions.dtd">
6  $Id$
8  Copyright (C) Authors contributing to this file.
10  This file is part of BASE - BioArray Software Environment.
11  Available at
13  BASE is free software; you can redistribute it and/or
14  modify it under the terms of the GNU General Public License
15  as published by the Free Software Foundation; either version 2
16  of the License, or (at your option) any later version.
18  BASE is distributed in the hope that it will be useful,
19  but WITHOUT ANY WARRANTY; without even the implied warranty of
21  GNU General Public License for more details.
23  You should have received a copy of the GNU General Public License
24  along with this program; if not, write to the Free Software
25  Foundation, Inc., 59 Temple Place - Suite 330,
26  Boston, MA  02111-1307, USA.
29<chapter id="resources">
30  <?dbhtml dir="resources"?>
31  <title>Resources</title>
32  <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
36    one of them.
37  </para>
38  <sect1 id="resources.home_page">
39    <title>BASE project site</title>
40    <para>
41      The BASE project site is located at
42      <ulink url=''></ulink>.
43      Here is a lot of useful information about the project and the program, e.g.
44      documentation/manuals, download-pages, contact information and much more. The most
45      important parts of the page are covered in this section.
46    </para>
47    <sect2 id="">
48      <title>Download</title>
49      <para>
50        The download page is accessed from the download section, on the home page, by
51        following the link to
52        <ulink url=''>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.
56        <variablelist>
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                available to checkout from the 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 guaranteed to
69                      work correctly and it is recommended to backup important
70                      data in the database before updating.
71                    </para>
72                  </listitem>
73                  <listitem>
74                    <para>
75                      Latest production release that contains bug fixes (not
76                      fully tested) for the latest tagged release.
77                    </para>
78                  </listitem>
79                  <listitem>
80                    <para>
81                      The production release that was last tagged in
82                      subversion.
83                    </para>
84                  </listitem>
85                </itemizedlist>
86              </para>
87            </listitem>
88          </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>
100        </variablelist>
101      </para>
102    </sect2>
103    <sect2 id="">
104      <title>Ticket system</title>
105      <para>
106        There is a tool button on BASE 2's home-page, called
107        <ulink url="">'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        or requesting a new feature. Perhaps someone has registered the issue as a ticket
111        already. This list can also be used to see how the BASE 2 development is proceeding
112        and when some particular request is planed to be fixed.
113      </para>
115      <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>
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.
126      </para>
128    </sect2>
129    <sect2 id="resources.home_page.documentation">
130      <title>Documentation</title>
131      <para>
132        All documentation that are associated with the project can be found in the
133        Documentation-section on the start page.
134        <variablelist>
135          <varlistentry>
136            <term>Manuals</term>
137            <listitem>
138              <para>
139                Useful information for the common user and the administrator, like
140                user documentation, installation instructions and administration
141                guide. These different documents will eventually be replaced with
142                this document when it includes the corresponding texts.
143              </para>
144            </listitem>
145          </varlistentry>
146          <varlistentry>
147            <term>Specifications</term>
148            <listitem>
149              <para>
150                This part contains specification for the separate divisions of the
151                project, such as core specification, web-client specification and
152                more.
153              </para>
154            </listitem>
155          </varlistentry>
156          <varlistentry>
157            <term>Developer information</term>
158            <listitem>
159              <para>
160                Information for those who are interested to be involved in the
161                development of BASE 2.
162              </para>
163            </listitem>
164          </varlistentry>
165          <varlistentry>
166            <term>Future development</term>
167            <listitem>
168              <para>
169                Link to a list of ideas for future development that aren't covered
170                and monitored in the milestones on the road map page. In other words
171                - ideas that are not planned to be done within nearest 6 to 12
172                month.
173              </para>
174            </listitem>
175          </varlistentry>
176        </variablelist>
177      </para>
178    </sect2>
179  </sect1>
180  <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
184      <ulink
185        url="">
186        link
187      </ulink>
188      to a page with available core plug-ins. All plugins that comes with the installation of
189      BASE 2 are listed on this page, some together with one or several examples of suitable
190      configuration files. These configuration files can be downloaded and imported with the
191      plugin-configuration importer in BASE 2.
192    </para>
193  </sect1>
194  <sect1 id="resources.plugins">
195    <title>BASE plug-ins site</title>
196    <para>
197      Plug-ins which aren't included in the installation of BASE 2, have their own site,
198      called
199      <ulink url="">BASE plug-ins web site</ulink>
200      which includes a download page for submitted none-core plug-ins. Here is also
201      information how to become a plug-in developer, with commit access to the repository, and
202      how to submit a plug-in to the download page.
203    </para>
204  </sect1>
205  <sect1 id="resources.demo_server">
206    <title>Demo server</title>
207    <para>
208      There is a demo server up running for anyone who wants to explore BASE 2 without having
209      to install it. Follow the link on BASE 2's home page to the demo server or go directly
210      to
211      <ulink url="">
213      </ulink>
214    </para>
215    <para>
216      Use
217      <userinput>base2</userinput>
218      as user/login name together with the password
219      <userinput>base2</userinput>
220      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).
223    </para>
224  </sect1>
225  <sect1 id="resources.mailing_lists">
226    <title>Mailing lists</title>
227    <para>
228      BASE project has three different mailing lists available for subscription. Visit the
229      <ulink url="">mailing list page</ulink>
230      to get more information about each one of the mailing lists. All posted mails are saved
231      in an archive for each list, it can therefore be a good idea to have a look here before
232      posting a new thread.
233    </para>
234    <para>
235      These are the available mailing lists, more details about each one of them can be found
236      on the mailing list page.
237      <itemizedlist>
238        <listitem>
239          <para>basedb-users</para>
240        </listitem>
241        <listitem>
242          <para>basedb-devel</para>
243        </listitem>
244        <listitem>
245          <para>basedb-announce</para>
246        </listitem>
247      </itemizedlist>
248    </para>
249  </sect1>
250  <sect1 id="resources.irc_channel">
251    <title>IRC channel</title>
252    <para>
253      There is a recently started irc channel on the FreeNode network where real-time BASE
254      discussion can take place twentyfour-seven. Use
255      <userinput>#basedb</userinput>
256      to connect to the channel on
257      <userinput></userinput>
258      or try to access
259      <ulink url="irc://"></ulink>
260      from a browser that supports IRC URLs
261    </para>
262    <para>
263      This is currently only a trial but will perhaps be extended depending on the interest of
264      using this discussion forum.
265    </para>
266    <important>
267      <title>Mailing lists are still #1</title>
268      <para>Use the mailing lists to get in contact with the development-team.</para>
269    </important>
270  </sect1>
Note: See TracBrowser for help on using the repository browser.