source: trunk/doc/src/docbook/overview/resources.xml @ 6465

Last change on this file since 6465 was 6465, checked in by Nicklas Nordborg, 8 years ago

Fixes #1798: Remove web services support

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id Date
File size: 9.8 KB
Line 
1<?xml version="1.0" encoding="UTF-8"?>
2<!DOCTYPE chapter PUBLIC
3    "-//Dawid Weiss//DTD DocBook V3.1-Based Extension for XML and graphics inclusion//EN"
4    "../../../../lib/docbook/preprocess/dweiss-docbook-extensions.dtd">
5<!--
6  $Id: resources.xml 6465 2014-06-04 12:41:12Z nicklas $
7 
8  Copyright (C) 2007 Jari Häkkinen, Peter Johansson, Nicklas Nordborg, Martin Svensson
9 
10  This file is part of BASE - BioArray Software Environment.
11  Available at http://base.thep.lu.se/
12 
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 3
16  of the License, or (at your option) any later version.
17 
18  BASE is distributed in the hope that it will be useful,
19  but WITHOUT ANY WARRANTY; without even the implied warranty of
20  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21  GNU General Public License for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with BASE. If not, see <http://www.gnu.org/licenses/>.
25-->
26
27<chapter id="resources" chunked="0">
28  <?dbhtml filename="resources.html"?>
29  <title>Resources</title>
30  <para>
31    There are several resources available for those who are using BASE
32    or have some other kind of interested in the BASE project. This
33    chapter contains information about those resources and also some
34    short instructions on how to use each one of them.
35  </para>
36  <sect1 id="resources.home_page">
37    <title>BASE project site</title>
38    <para>
39      The BASE project site is located at
40      <ulink url='http://base.thep.lu.se'>http://base.thep.lu.se</ulink>.
41      Here is a lot of useful information about the project and the program, e.g.
42      documentation/manuals, download-pages, contact information and much more. The most
43      important parts of the page are covered in this section.
44    </para>
45    <sect2 id="resources.home_page.download">
46      <title>Download</title>
47      <para>
48        The download page is accessed from the download section, on the home page, by
49        following the link to
50        <guilabel><ulink url='http://base.thep.lu.se/wiki/DownloadPage'
51          >Download Page</ulink></guilabel>.
52        From this page you can download BASE releases as packaged tar.gz
53        files or checkout the source code directly from the Subversion repository.
54        See the separate parts on the web page to get more information how to
55        proceed with each one of them.
56       
57        <variablelist>
58          <varlistentry>
59            <term>Packaged BASE releases</term>
60            <listitem>
61              <para>
62                Both source-packages and binary-packages are available for each release
63                of the program.
64              </para>
65            </listitem>
66          </varlistentry>
67          <varlistentry>
68            <term>Repository access</term>
69            <listitem>
70              <para>
71                With this option the visitor can get the source code directly from
72                Subversion. There are at least three different version that are
73                available to checkout from the repository.
74                <itemizedlist>
75                  <listitem>
76                    <para>
77                      The latest production release. This will give you
78                      the same source code as one of the packaged
79                      releases.
80                    </para>
81                  </listitem>
82                  <listitem>
83                    <para>
84                      The latest non-released bugfix branch. Use this if
85                      you are affected by a bug that has been fixed but not
86                      yet released.
87                    </para>
88                  </listitem>
89                  <listitem>
90                    <para>
91                      Bleeding edge of the software, which is the latest
92                      revision of the program. The code is not guaranteed to
93                      work correctly and it is recommended to backup important
94                      data in the database before updating. Use this at your own
95                      risk, we cannot guarantee that you will be able to upgrade
96                      the installation to another version or release.
97                    </para>
98                  </listitem>
99                </itemizedlist>
100              </para>
101            </listitem>
102          </varlistentry>
103        </variablelist>
104      </para>
105    </sect2>
106    <sect2 id="resources.home_page.tickets">
107      <title>Ticket system</title>
108
109      <para>
110        A ticket is a note about a bug or a new feature that has not yet been
111        implemented. To show the list of outstanding tickets use the
112        <guibutton><ulink url="http://base.thep.lu.se/query"
113          >View Tickets</ulink></guibutton> button on BASE web site.
114        It is a good idea to have a look at this list before reporting a bug
115        or requesting a new feature. Perhaps someone has registered the issue as a ticket
116        already. This list can also be used to see how the BASE development is proceeding
117        and when some particular request is planned to be fixed.
118      </para>
119
120      <para>
121        To report bugs, add feature requests, and comment an existing ticket, you needs to
122        be logged in to the trac environment. This is done by clicking on the
123        <guilabel>login</guilabel>-link to
124        the right in the upper corner on the home page. The <guilabel>Feedback</guilabel>-section,
125        also on the home page, contains more information how to proceed.
126      </para>
127    </sect2>
128    <sect2 id="resources.home_page.roadmap">
129      <title>Roadmap</title>
130
131      <para>
132        The roadmap of BASE is accessed from the
133        <guibutton><ulink url="http://base.thep.lu.se/roadmap"
134          >Roadmap</ulink></guibutton> button on the home page. This page
135        contains information about the plans for future development, including
136        the tickets that should be fixed for each milestone. Usually, only
137        the next upcoming release has a date set. The <guilabel>BASE Future Release</guilabel>
138        milestone is used to collected tickets that we think should be fixed
139        but are less important or require too much work. Contributions are welcome.
140      </para>
141
142    </sect2>
143    <sect2 id="resources.home_page.documentation">
144      <title>Documentation</title>
145      <para>
146        All documentation that are associated with the project can be found in the
147        Documentation-section on the start page.
148        <variablelist>
149          <varlistentry>
150            <term>Manuals</term>
151            <listitem>
152              <para>
153                Useful information for the common user and the administrator, like
154                user documentation, installation instructions and administration
155                guide. These different documents will eventually be replaced with
156                this document when it includes the corresponding texts.
157              </para>
158            </listitem>
159          </varlistentry>
160          <varlistentry>
161            <term>Specifications</term>
162            <listitem>
163              <para>
164                This part contains specification for the separate divisions of the
165                project, such as core specification, web-client specification and
166                more.
167              </para>
168            </listitem>
169          </varlistentry>
170          <varlistentry>
171            <term>Developer information</term>
172            <listitem>
173              <para>
174                Information for those who are interested to be involved in the
175                development of BASE.
176              </para>
177            </listitem>
178          </varlistentry>
179          <varlistentry>
180            <term>Future development</term>
181            <listitem>
182              <para>
183                Link to a list of ideas for future development that are not covered
184                and monitored in the milestones on the road map page. In other words
185                - ideas that are not planned to be done within nearest 6 to 12
186                month.
187              </para>
188            </listitem>
189          </varlistentry>
190        </variablelist>
191      </para>
192    </sect2>
193  </sect1>
194  <sect1 id="resources.plugins">
195    <title>BASE plug-ins site</title>
196    <para>
197      Plug-ins which are not included in the installation of BASE, have their own site,
198      called
199      <ulink url="http://baseplugins.thep.lu.se/">BASE plug-ins web site</ulink>
200      which includes a download page for submitted none-core plug-ins.     
201      Here is also information how to become a plug-in developer, with
202      commit access to the repository, and how to submit a plug-in to the
203      download page. You will also be able to find example
204      code for plug-ins, extensions, etc.
205    </para>
206  </sect1>
207  <sect1 id="resources.demo_server">
208    <title>Demo server</title>
209    <para>
210      There is a demo server up running for anyone who wants to
211      explore BASE without having to install it. Follow the link on
212      BASE web site to the demo server or go directly to
213      <ulink url="http://base2.thep.lu.se/demo/">
214        http://base2.thep.lu.se/demo/
215      </ulink>
216    </para>
217    <para>
218      Use <userinput>base2</userinput> as login
219      and <userinput>base2</userinput> as password to login to the
220      demo server. The base2 user account has read privileges to all
221      data on the demo server and can view almost every list page. If
222      extended privileges are wanted, please contact the administrator
223      of the demo server (see the bottom of the browser when visiting
224      the demo server).
225    </para>
226  </sect1>
227  <sect1 id="resources.mailing_lists">
228    <title>Mailing lists</title>
229    <para>
230      BASE project has three different mailing lists available for subscription. Visit the
231      <ulink url="http://base.thep.lu.se/wiki/MailingLists">mailing list page</ulink>
232      to get more information about each one of the mailing lists. All posted mails are saved
233      in an archive for each list, it can therefore be a good idea to have a look here before
234      posting a new thread.
235    </para>
236    <para>
237      These are the available mailing lists, more details about each one of them can be found
238      on the mailing list page.
239      <itemizedlist>
240        <listitem>
241          <para>basedb-users</para>
242        </listitem>
243        <listitem>
244          <para>basedb-devel</para>
245        </listitem>
246        <listitem>
247          <para>basedb-announce</para>
248        </listitem>
249      </itemizedlist>
250    </para>
251  </sect1>
252
253  <sect1 id="resources.basehacks">
254    <title>BASE-hacks</title>
255    <para>
256      There is a trac/subversion server keeping track of changes made
257      to third party projects that are changed to make them work with
258      BASE. Open source project usually have a requirement that
259      changes are made public. On
260      the <ulink
261      url='http://dev.thep.lu.se/basehacks'>BASE-hacks web
262      site</ulink> you will find a list of modified packages and
263      information about the changes performed.
264    </para>
265  </sect1>
266
267</chapter>
Note: See TracBrowser for help on using the repository browser.