Feature #2875

[Workbench] Editable description field for pipeline instances and templates

Added by Ward Vandewege over 7 years ago. Updated about 7 years ago.

Status:
Resolved
Priority:
Normal
Assigned To:
Radhika Chippada
Category:
Workbench
Target version:
Start date:
09/11/2014
Due date:
% Done:

100%

Estimated time:
(Total: 8.00 h)
Story points:
1.0

Description

Augment the existing editable "description" field on the "show project" page.
  • Add a description attribute to the pipeline_instances and jobs models. (See Hacking API server)
  • Make an "editable name and description" partial so any object that has a description and name attributes automatically has the same editable name/description section at the top of the page as the current "show project" page.
  • Currently the instance#show page shows a misleading description taken from the pipeline template (see #3765). This will be less misleading if we:
    1. Do not show the template's description at all on the instance page.
    2. Do not show the template's name in the same location/style we usually use for properties of the current object. (Perhaps a <div class="alert alert-info"> in the top right corner would be better?)
    3. Add a phrase after the template name/link saying "(note: template has been modified since this instance was created)" when that's true

Also set an initial description field when creating a pipeline instance -- something like

Created using "{template name}" pipeline template on {date/time}

Ideally, arv-run-pipeline-instance should also set the description to something similar. (And accept a command line argument to override)

Note: #3036 adds a description attribute to PipelineInstance and Job (and a name attribute to Job). If #3036 isn't merged when you get started on this, take the 20140815171049_add_name_description_columns.rb migration from the 3036-collection-uuids branch instead of making a conflicting one.


Subtasks

Task #3039: Add description attribute to PipelineInstance modelResolvedRadhika Chippada

Task #3191: Add editable title/description fields to pipeline template and pipeline instance pages, just like project pageResolvedRadhika Chippada

Task #3765: [Workbench] Pipeline instance #show page should not show the _current_ template name/description in a misleading way (the template might have been edited beyond recognition since the instance was created)ResolvedRadhika Chippada

Task #3867: Add description option to arv-run-pipeline-instance scriptResolvedRadhika Chippada

Task #3868: Add / update integration tests to verify description for pipeline templates, instances, and jobs.ResolvedRadhika Chippada

Task #3861: Review branch: 2875-pipeline-descriptionResolvedPeter Amstutz

Associated revisions

Revision 4dedb0cc
Added by Radhika Chippada about 7 years ago

closes #2875
Merge branch '2875-pipeline-description'

History

#1 Updated by Ward Vandewege over 7 years ago

  • Description updated (diff)

#2 Updated by Tim Pierce over 7 years ago

  • Assigned To set to Tim Pierce

#3 Updated by Tim Pierce over 7 years ago

  • Subject changed from Edit a textile description of my {pipeline, collection, folder} detail tab/section to Edit a textile description of my {pipeline, folder} detail tab/section

#4 Updated by Tom Clegg over 7 years ago

  • Target version changed from 2014-06-17 Curating and Crunch to 2014-07-16 Sprint

#5 Updated by Tom Clegg over 7 years ago

  • Assigned To deleted (Tim Pierce)

#6 Updated by Tom Clegg over 7 years ago

  • Description updated (diff)

#7 Updated by Tom Clegg over 7 years ago

  • Subject changed from Edit a textile description of my {pipeline, folder} detail tab/section to Edit a textile description of my {pipeline, project} detail tab/section

#8 Updated by Tom Clegg over 7 years ago

  • Target version deleted (2014-07-16 Sprint)

#9 Updated by Tom Clegg over 7 years ago

  • Description updated (diff)

#10 Updated by Tom Clegg over 7 years ago

  • Target version set to 2014-08-06 Sprint

#11 Updated by Tom Clegg over 7 years ago

  • Subject changed from Edit a textile description of my {pipeline, project} detail tab/section to [Workbench] Edit a textile description of my {pipeline, project} detail tab/section
  • Category set to Workbench

#12 Updated by Peter Amstutz over 7 years ago

  • Assigned To set to Peter Amstutz

#13 Updated by Tom Clegg over 7 years ago

  • Target version changed from 2014-08-06 Sprint to Arvados Future Sprints

#14 Updated by Tom Clegg over 7 years ago

  • Subject changed from [Workbench] Edit a textile description of my {pipeline, project} detail tab/section to [Workbench] Editable description field for pipeline instances, templates, and jobs
  • Description updated (diff)
  • Assigned To deleted (Peter Amstutz)

#15 Updated by Tom Clegg about 7 years ago

  • Story points changed from 2.0 to 1.0

#16 Updated by Tom Clegg about 7 years ago

  • Target version changed from Arvados Future Sprints to 2014-08-27 Sprint

#17 Updated by Radhika Chippada about 7 years ago

  • Assigned To set to Radhika Chippada

#18 Updated by Tom Clegg about 7 years ago

  • Description updated (diff)

#19 Updated by Ward Vandewege about 7 years ago

  • Target version changed from 2014-08-27 Sprint to 2014-09-17 sprint

#20 Updated by Tom Clegg about 7 years ago

  • Subject changed from [Workbench] Editable description field for pipeline instances, templates, and jobs to [Workbench] Editable description field for pipeline instances and templates
  • Description updated (diff)

#21 Updated by Tom Clegg about 7 years ago

  • Description updated (diff)

#22 Updated by Tom Clegg about 7 years ago

  • Description updated (diff)

#23 Updated by Radhika Chippada about 7 years ago

  • Status changed from New to In Progress

#24 Updated by Tom Clegg about 7 years ago

Noticed several suspicious lines like this in services/api/db/structure.sql (note the timestamp):

+INSERT INTO schema_migrations (version) VALUES ('20140509143351');
+

(There is no such migration in the source tree, so surely this isn't right. Perhaps these rows in your schema_migrations table are left over from old migrations during development/review and need to be deleted?)

  • Tom, thanks for noticing this and explaining it. I removed these junk lines from db/structure.sql and I also removed them from my schema_migrations table to prevent this from happening again. Thanks.

#25 Updated by Peter Amstutz about 7 years ago

  1. Collections page has name listed twice, description should go into the info panel like we discussed
  2. Grammar fix: "This pipeline has been created from the template ..." -> "This pipeline was created from the template ..."

#26 Updated by Radhika Chippada about 7 years ago

  • Status changed from In Progress to Resolved
  • % Done changed from 83 to 100

Applied in changeset arvados|commit:4dedb0cc8921e7210ed245107b83996eb0d4e974.

Also available in: Atom PDF