session update

lidaof · Jul 22, 2020 · 4230c2d · 4230c2d
1 parent 2e0e5c5
commit 4230c2d
Show file tree

Hide file tree

Showing 6 changed files with 37 additions and 1 deletion.
diff --git a/docs/_static/hubLink.png b/docs/_static/hubLink.png
diff --git a/docs/_static/sessionFile.png b/docs/_static/sessionFile.png
diff --git a/docs/_static/sessionLink.png b/docs/_static/sessionLink.png
diff --git a/docs/faq.rst b/docs/faq.rst
@@ -50,3 +50,29 @@ More discussions about this please check here_.
 
 .. _here: https://github.com/lidaof/eg-react/issues/114
 
+What's the different between ``hub`` and ``sessionFile`` URL parameter
+----------------------------------------------------------------------
+
+Both browser links with ``hub`` or ``sessionFile`` can be shared with others or be used for publication purpose. ``sessionFile`` not only contains all the *tracks*
+as ``hub``, it also contains genomic coordinates, metadata, show/hide of genome navigator etc.
+
+So ``sessionFile`` link contains more information than ``hub`` link, as the ``sessionFile`` contains more contents only used by the browser (it's much more complex than ``hub`` file syntax).
+
+Examples links:
+
+`hub link <https://epigenomegateway.wustl.edu/browser/?genome=hg19&hub=https://wangftp.wustl.edu/~dli/test/a.json>`_
+
+.. image:: _static/hubLink.png
+
+`sessionFile link <https://epigenomegateway.wustl.edu/browser/?genome=hg19&sessionFile=https://wangftp.wustl.edu/~dli/test/eg-session-Hl4320IQ8-5b4bcd10-cbcd-11ea-b1b4-6196abf220ba.json>`_
+
+.. image:: _static/sessionLink.png
+
+Publish with the browser
+------------------------
+
+First thank you very much for considering publishing figures, datahubs and session links using the Browser.
+For best result, please put all your track files on a permenant web location (like your own web server or Amazon S3), 
+then  use :ref:`hub` or :ref:`sessionFile` URL parameter for browser hub URL. Browser URL with ``hub`` or ``sessionFile`` is permenant as long as your track files from your web server stay.
+
+.. note:: using ``session bundle Id`` is not recommended as session Id is suppose to be shared with trusted people, share the session Id in a public enviroment may result unwanted edits to your session.
diff --git a/docs/installation.rst b/docs/installation.rst
@@ -8,6 +8,8 @@ Setup
 
 .. note:: Feel free to use any package manager tool on your system for installation (``brew``\ , etc.).
 
+* Get the source code from our github repo: https://github.com/lidaof/eg-react
+
 Start the browser
 -----------------
 

diff --git a/docs/url.rst b/docs/url.rst
@@ -8,8 +8,10 @@ Specify the genome in URL. It's required for all other URL parameters.
 
 Example: ``?genome=hg19``
 
+.. _hub:
+
 hub
-----
+---
 
 Specify a data hub URL in JSON format.
 
@@ -22,13 +24,19 @@ Specify a session bundle ID in URL.
 
 Example: ``?genome=hg19&bundle=session-bundle-id``
 
+.. _sessionFile:
+
 sessionFile
 -----------
 
 Specify a session file in URL.
 
 Example: ``?sessionFile=https://wangftp.wustl.edu/~dli/test/eg-session--1692c5f0-c392-11e9-829c-912864922e1e.json``
 
+.. note:: ``sessionFile`` can be downloaded using the ``Download current session`` button in Session user interface.
+
+          .. image:: _static/sessionFile.png
+
 hicUrl
 -------