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

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter PUBLIC 
    "-//Dawid Weiss//DTD DocBook V3.1-Based Extension for XML and graphics inclusion//EN" 
    "../../../../lib/docbook/preprocess/dweiss-docbook-extensions.dtd">
<!--
  $Id: resources.xml 7982 2021-06-14 08:01:21Z nicklas $
  
  Copyright (C) 2007 Jari Häkkinen, Peter Johansson, Nicklas Nordborg, Martin Svensson
  
  This file is part of BASE - BioArray Software Environment.
  Available at http://base.thep.lu.se/
  
  BASE is free software; you can redistribute it and/or
  modify it under the terms of the GNU General Public License
  as published by the Free Software Foundation; either version 3
  of the License, or (at your option) any later version.
  
  BASE is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.
  
  You should have received a copy of the GNU General Public License
  along with BASE. If not, see <http://www.gnu.org/licenses/>.
-->

<chapter id="resources" chunked="0">
  <?dbhtml filename="resources.html"?>
  <title>Resources</title>
  <para>
    There are several resources available for those who are using BASE
    or have some other kind of interested in the BASE project. This
    chapter contains information about those resources and also some
    short instructions on how to use each one of them.
  </para>
  <sect1 id="resources.home_page">
    <title>BASE project site</title>
    <para>
      The BASE project site is located at
      <ulink url='https://base.thep.lu.se'>https://base.thep.lu.se</ulink>.
      Here is a lot of useful information about the project and the program, e.g.
      documentation/manuals, download-pages, contact information and much more. The most
      important parts of the page are covered in this section.
    </para>
    <sect2 id="resources.home_page.download">
      <title>Download</title>
      <para>
        The download page is accessed from the download section, on the home page, by
        following the link to
        <guilabel><ulink url='https://base.thep.lu.se/wiki/DownloadPage'
          >Download Page</ulink></guilabel>. 
        From this page you can download BASE 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 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>
            <listitem>
              <para>
                With this option the visitor can get the source code directly from
                Subversion. There are at least three different version that are
                available to checkout from the repository.
                <itemizedlist>
                  <listitem>
                    <para>
                      The latest production release. This will give you
                      the same source code as one of the packaged
                      releases.
                    </para>
                  </listitem>
                  <listitem>
                    <para>
                      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>
                      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 cannot guarantee that you will be able to upgrade
                      the installation to another version or release.
                    </para>
                  </listitem>
                </itemizedlist>
              </para>
            </listitem>
          </varlistentry>
        </variablelist>
      </para>
    </sect2>
    <sect2 id="resources.home_page.tickets">
      <title>Ticket system</title>

      <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="https://base.thep.lu.se/query"
          >View Tickets</ulink></guibutton> button on BASE web site. 
        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 development is proceeding
        and when some particular request is planned to be fixed.
      </para>

      <para>
        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 is accessed from the 
        <guibutton><ulink url="https://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 Future Release</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>

    </sect2>
    <sect2 id="resources.home_page.documentation">
      <title>Documentation</title>
      <para>
        All documentation that are associated with the project can be found in the
        Documentation-section on the start page.
        <variablelist>
          <varlistentry>
            <term>Manuals</term>
            <listitem>
              <para>
                Useful information for the common user and the administrator, like
                user documentation, installation instructions and administration
                guide. These different documents will eventually be replaced with
                this document when it includes the corresponding texts.
              </para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term>Specifications</term>
            <listitem>
              <para>
                This part contains specification for the separate divisions of the
                project, such as core specification, web-client specification and
                more.
              </para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term>Developer information</term>
            <listitem>
              <para>
                Information for those who are interested to be involved in the
                development of BASE.
              </para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term>Future development</term>
            <listitem>
              <para>
                Link to a list of ideas for future development that are not covered
                and monitored in the milestones on the road map page. In other words
                - ideas that are not planned to be done within nearest 6 to 12
                month.
              </para>
            </listitem>
          </varlistentry>
        </variablelist>
      </para>
    </sect2>
  </sect1>
  <sect1 id="resources.plugins">
    <title>BASE plug-ins site</title>
    <para>
      Plug-ins which are not included in the installation of BASE, have their own site,
      called
      <ulink url="https://baseplugins.thep.lu.se/">BASE plug-ins web site</ulink>
      which includes a download page for submitted none-core plug-ins.      
      Here is also information how to become a plug-in developer, with 
      commit access to the repository, and how to submit a plug-in to the 
      download page. You will also be able to find example
      code for plug-ins, extensions, etc.
    </para>
  </sect1>
  <sect1 id="resources.demo_server">
    <title>Demo server</title>
    <para>
      There is a demo server up running for anyone who wants to
      explore BASE without having to install it. Follow the link on
      BASE web site to the demo server or go directly to
      <ulink url="https://base.onk.lu.se/demo/">
        https://base.onk.lu.se/demo/
      </ulink>. NOTE! The demo server is currently down!
    </para>
    <para>
      Use <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 are wanted, please contact the administrator
      of the demo server (see the bottom of the browser when visiting
      the demo server).
    </para>
  </sect1>
  <sect1 id="resources.mailing_lists">
    <title>Mailing lists</title>
    <para>
      BASE project has three different mailing lists available for subscription. Visit the
      <ulink url="https://base.thep.lu.se/wiki/MailingLists">mailing list page</ulink>
      to get more information about each one of the mailing lists. All posted mails are saved
      in an archive for each list, it can therefore be a good idea to have a look here before
      posting a new thread.
    </para>
    <para>
      These are the available mailing lists, more details about each one of them can be found
      on the mailing list page.
      <itemizedlist>
        <listitem>
          <para>basedb-users</para>
        </listitem>
        <listitem>
          <para>basedb-devel</para>
        </listitem>
        <listitem>
          <para>basedb-announce</para>
        </listitem>
      </itemizedlist>
    </para>
  </sect1>

  <sect1 id="resources.basehacks">
    <title>BASE-hacks</title>
    <para>
      There is a trac/subversion server keeping track of changes made
      to third party projects that are changed to make them work with
      BASE. Open source project usually have a requirement that
      changes are made public. On
      the <ulink
      url='http://dev.thep.lu.se/basehacks'>BASE-hacks web
      site</ulink> you will find a list of modified packages and
      information about the changes performed.
    </para>
  </sect1>

</chapter>