Skip to content

Commit

Permalink
Update installation instructions.
Browse files Browse the repository at this point in the history
  • Loading branch information
laceysanderson committed Dec 5, 2019
1 parent f74597d commit 155d008
Show file tree
Hide file tree
Showing 5 changed files with 9 additions and 15 deletions.
Binary file modified docs/assets/settings_page.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
11 changes: 2 additions & 9 deletions docs/guide/install/instance_page.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,5 @@

This module is available for download from github.com/tripal/tripal_jbrowse.

1. Download and upack the module into ``[DRUPAL ROOT]/sites/all/modules`` where ``DRUPAL_ROOT`` is the path to your Drupal site.
2. Navigate to ``https://yourdrupalsite.com/admin/modules`` or click **Administration Toolbar > Modules**
3. Scroll to **Tripal Extensions**, click the checkbox beside "Tripal JBrowse Integration", and click the "Save Configuration" button at the bottom of the page.

.. image:: ../../assets/tripal_jbrowse.1.install.png

.. note::

This module is dependent upon the **Link** module. It is not mentioned above in the install instructions since you should already have installed it when installing Tripal.
1. First install :doc:`Tripal JBrowse Management <jbrowse_mgmt>`
2. Run ``drush en -y tripal_jbrowse_page`` or enable through the modules page
5 changes: 3 additions & 2 deletions docs/guide/install/jbrowse_mgmt/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@ Configuration
===============

In order for the module to function properly, you need to first configure it.
Please visit ``http://YOUR_SITE/admin/tripal_jbrowse/configure`` (replace YOUR_SITE with your domain)
and fill out the form. You will need to know information about your JBrowse information.

1. Visit your site through the browser and navigate to Administration » Tripal » Extensions » Tripal JBrowse Management » Settings.
2. Fill out the configuration form and click "Save Settings". **You will need to know information about your JBrowse instance.**

.. image:: ../../../assets/settings_page.png
4 changes: 2 additions & 2 deletions docs/guide/install/jbrowse_mgmt/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@ Installation
==============

1. Download the module to your Drupal modules folder
2. Run drush en -y hardwoods_jbrowse or enable through the modules page
3. Visit the configuration page at /admin/hardwoods_jbrowse/configure
2. Run ``drush en -y tripal_jbrowse_mgmt`` or enable through the modules page
3. Visit the configuration page at Administration » Tripal » Extensions » Tripal JBrowse Management » Settings

.. note::

Expand Down
4 changes: 2 additions & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ Tripal JBrowse

This package of modules integrates `GMOD JBrowse <https://jbrowse.org/>`_ into your `Tripal <http://tripal.info/>`_ site providing

- Tripal page integration via **Tripal JBrowse** and
- a user interface for JBrowse instance creation and management via **Tripal JBrowse Management**.
1. A user interface for JBrowse instance creation and management via **Tripal JBrowse Management**
2. Drupal menu links and pages with embedded JBrowse instances via **Tripal-JBrowse Page Integration**

This powerful combination allows you to provide seamless genome browsing to your users in an administrator-friendly manner.

Expand Down

0 comments on commit 155d008

Please sign in to comment.