Skip to content

Commit

Permalink
Highlights fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
nsoranzo committed Mar 9, 2018
1 parent 9e27427 commit e68ac4a
Showing 1 changed file with 22 additions and 20 deletions.
42 changes: 22 additions & 20 deletions doc/source/releases/18.01_announce.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,26 +17,26 @@ Highlights
`Pull Request 5533`_, `Pull Request 5615`_, `Pull Request 5616`_

**Web Server and Configuration**
The default web server used by Galaxy has changed from Paste to uWSGI and the default configuration file for Galaxy is now ``config/galaxy.yml`` instead of ``config/galaxy.ini``.
The default web server used by Galaxy has changed from Paste to `uWSGI <https://uwsgi-docs.readthedocs.io/>`__ and the default configuration file for Galaxy is now ``config/galaxy.yml`` instead of ``config/galaxy.ini``.
uWSGI is more production ready and should allow Galaxy to scale better in its default
configuration. In the future uWSGI will allow Galaxy to setup GIE proxies without additional
configuration and use modern web technologies such as web sockets.

To minimize the impact of this on existing Galaxy instances, if a Galaxy has an existing ``galaxy.ini``
file configured it will continue to use Paste by default unless additional steps are
taken by the administrator (one can force Galaxy to start in uWSGI even with an older configuration file
To minimize the impact of this on existing Galaxy instances, if a Galaxy has a ``galaxy.ini``
file configured, it will continue to use Paste by default unless additional steps are
taken by the administrator (Galaxy can be forced to start under uWSGI even with an older configuration file
by setting ``APP_WEBSERVER=uwsgi`` in the environment). As part of the transition to YAML-based
configuration files we have implemented a schema to validate Galaxy configuration files. Run
configuration files, we have implemented a schema to validate Galaxy configuration files. Run
``make config-validate`` from Galaxy's root directory to validate a schema and ``make config-lint`` to
check for best practices. While there is no need to convert your configuration file (``galaxy.ini`` hasn't
been deprecated), we have included make targets ``make config-convert-dry-run`` and ``make config-convert``
to assist converting an ``ini`` configuration file to a YAML one.
been deprecated), you can run ``make config-convert-dry-run`` and ``make config-convert``
to respectively test and perform the conversion of an ``ini`` configuration file to a YAML one.

These are big changes that affect many parts of Galaxy's administration documentation and makes
this documentation very dependent on which Galaxy version they are targeting. To address this, we have
moved a significant amount of administration documentation into Galaxy's code
base and made it available on a per release basis. The latest administration documentation for
the previous release of Galaxy (17.09) which reference galaxy.ini files and Paste servers can
base and made it available on a per-release basis. The latest administration documentation for
the previous release of Galaxy (17.09) which reference ``galaxy.ini`` files and Paste servers can
be found `here <https://docs.galaxyproject.org/en/release_17.09/admin/index.html>`__, while documentation for this release can be found `here <https://docs.galaxyproject.org/en/release_18.01/admin/index.html>`__.

`Pull Request 4475`_, `Pull Request 5135`_, `Pull Request 5390`_, `Pull Request 5373`_,
Expand All @@ -46,9 +46,9 @@ Highlights
The architecture for the client code that powers the Galaxy user interface has been significantly
overhauled. The code base has been converted to `ES6 <http://es6-features.org/>`__,
`Yarn <https://github.com/yarnpkg/yarn>`__ now powers the build and dependency management of the code,
`Prettier <https://prettier.io/>`__ is now used ensure consistent code formatting,
and the `VueJS <https://vuejs.org/>`__ framework has been integrated. Taken together these changes will
enable Galaxy developers to write usable, responsive client code more quickly and concisely than
`Prettier <https://prettier.io/>`__ is now used to ensure consistent code formatting,
and the `VueJS <https://vuejs.org/>`__ framework has been integrated. Taken together, these changes are
enabling Galaxy developers to write usable, responsive client code more quickly and concisely than
previously possible. A big thanks goes out to community contributions from
`@anuprulez <https://github.com/anuprulez>`__ and `@anatskiy <https://github.com/anatskiy>`__ that are
already converting existing Galaxy components to reactive VueJS ones.
Expand All @@ -61,12 +61,14 @@ Highlights
`Pull Request 5294`_

**New BAM datatypes**
Previously Galaxy only supported coordinate sorted BAM files by default (the ``bam`` datatype). This
release of Galaxy now supports three new types of BAM file - including ``qname_sorted.bam`` that
ensures that the file is queryname sorted (e.g. ``SO:queryname``), ``qname_input_sorted.bam`` that
can be used to describe the output of aligners which generally keep mate pairs adjacent, and ``native_bam``
that makes no assumptions about the sort order of the file. A huge thanks goes out to
`@bgruening <https://github.com/bgruening>`__ and `@mvdbeek <https://github.com/mvdbeek>`__ who
Previously Galaxy only supported coordinate sorted BAM files by default (the ``bam`` datatype). In addition, this
release of Galaxy now supports three new types of BAM:

- ``qname_sorted.bam``, that ensures that the file is queryname sorted (e.g. ``SO:queryname``);
- ``qname_input_sorted.bam``, that can be used to describe the output of aligners which generally keep mate pairs adjacent
- ``native_bam``, that makes no assumptions about the sort order of the file.

A huge thanks goes out to `@bgruening <https://github.com/bgruening>`__ and `@mvdbeek <https://github.com/mvdbeek>`__ who
implemented these datatypes.

`Pull Request 5180`_, `Pull Request 5589`_, `Pull Request 5532`_, `Pull Request 5644`_
Expand All @@ -80,7 +82,7 @@ Highlights

**Dataset Collection Usability**
This release has significantly improved the usability of Galaxy dataset collections. Dozens of improvements
to collections have been made, some the key highlights include:
to collections have been made, some of the key highlights include:

- Data library folders can now be sent to histories as a dataset collection. `Pull Request 4998`_, `Pull Request 5080`_
- Failed dataset collection elements can now be fixed using job re-running (thanks to `@mvdbeek <https://github.com/mvdbeek>`__). `Pull Request 5321`_, `Pull Request 5247`_, `Pull Request 5270`_
Expand Down Expand Up @@ -136,7 +138,7 @@ The following features that have been deprecated in the past releases are being
* Sample request and external services management
* Legacy library interface for Administrators

In addition to that the PlantTribes datatypes have been commented out in the source code. Uncomment them if you want to re-enable it.
In addition to that, the PlantTribes datatypes have been commented out in the source code. Uncomment them if you want to re-enable it.

Release Notes
=============
Expand Down

0 comments on commit e68ac4a

Please sign in to comment.