Skip to content

Commit

Permalink
Add more details to publishing design doc
Browse files Browse the repository at this point in the history
  • Loading branch information
amoeba committed Feb 10, 2018
1 parent 85f9d05 commit 103dc51
Showing 1 changed file with 27 additions and 1 deletion.
28 changes: 27 additions & 1 deletion mockups/tale-publishing/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,17 @@ Solution should satisfy these requirements:
3. A none-zero amount of provenance information should be archived
4. Published tales have to work outside the WT environment (to at least some degree) (not necessarily as seamless as in WT?)

Approach
--------

Make as much use of existing tools as possible.
To publish Tales, we'll need to create metadata, provenance information, and package everything up for saving to external repositories.

- Metadata: Re-use MetacatUI_ and its advanced EML Editor
- Provenance: Re-use MetacatUI_ and its graphical provenance editor

.. _MetacatUI: https://github.com/NCEAS/metacatui

Verbage
-------

Expand All @@ -43,20 +54,26 @@ They can now Publish their Tale in a series of steps:
Tale View
*********

The Tale View is one of the two places a user can Publish from.

Note: This is a very rough mockup and does not reflect how it will look when implemented.

.. image:: images/tale_view.png

Tales View (Status)
Status View
*******************

The Status View is one of the two places a user can Publish from.

Note: This is a very rough mockup and does not reflect how it will look when implemented.

.. image:: images/tale_status.png

Tale Publication View
*********************

Once the user has clicked Publish Tale in either the Tale or Status View, they see this modal dialog.

Note: This is a very rough mockup and does not reflect how it will look when implemented.

.. image:: images/tale_publish.png
Expand Down Expand Up @@ -94,6 +111,13 @@ Generating Metadata

A minimal EML record will be created automatically when the skeleton Data Package is created.
The Dashboard or Backend needs to be able to generate a minimal EML record which shouldn't be hard.
The user will create more descriptive metadata using MetacatUI.

Generating Provenance
*********************

Provenance traces generated from scripted environments will be published with the Tale by default.
The user can also manually describe provenance with the MetacatUI provenance editor.

Saving to the External Repository
*********************************
Expand Down Expand Up @@ -136,6 +160,8 @@ For DataONE, this includes:
Archived Material
=================

Everything below here is old stuff I didn't want to nuke just yet.

High-level Questions
--------------------

Expand Down

0 comments on commit 103dc51

Please sign in to comment.