Skip to content

Commit

Permalink
Update docs, add beginnings of usage
Browse files Browse the repository at this point in the history
  • Loading branch information
davidlougheed committed Jan 20, 2020
1 parent 1ba693c commit e5884cf
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 7 deletions.
12 changes: 7 additions & 5 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,4 @@
.. CHORD documentation master file, created by
sphinx-quickstart on Mon Sep 30 17:01:53 2019.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
=====
CHORD
=====

Expand All @@ -28,3 +24,9 @@ CHORD
services/chord_service_types
services/creating_a_service
services/bundled_services

.. toctree::
:maxdepth: 2
:caption: Usage

usage/adding_data_to_drop_box
4 changes: 2 additions & 2 deletions docs/services/chord_service_types.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ confusion.
+--------------+------------------+---------------------------------------------------+
| ca.c3g.chord | drop-box | https://github.com/c3g/chord_drop_box_service |
+--------------+------------------+---------------------------------------------------+
| ca.c3g.chord | drs | https://github.com/c3g/chord_drs |
+--------------+------------------+---------------------------------------------------+
| ca.c3g.chord | wes | https://github.com/c3g/chord_wes |
+--------------+------------------+---------------------------------------------------+
| ca.c3g.chord | federation | https://github.com/c3g/chord_federation |
Expand All @@ -23,7 +25,5 @@ confusion.
+--------------+------------------+---------------------------------------------------+
| ca.c3g.chord | metadata | https://github.com/c3g/chord_metadata_service |
+--------------+------------------+---------------------------------------------------+
| ca.c3g.chord | example | https://github.com/c3g/chord_example_service |
+--------------+------------------+---------------------------------------------------+
| ca.c3g.chord | variant | https://github.com/c3g/chord_variant_service |
+--------------+------------------+---------------------------------------------------+
8 changes: 8 additions & 0 deletions docs/usage/adding_data_to_drop_box.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
===========================
Adding Data to the Drop Box
===========================

Currently, no upload mechanism is available for CHORD. Files should be copied
via some out-of-band mechanism to the CHORD node and placed in whichever folder
is bound to ``/chord/data/drop-box`` inside the container. These files and
folders will appear in the front end's "Files" section.

0 comments on commit e5884cf

Please sign in to comment.