Merge pull request #4163 from IQSS/develop

v4.8

Author: kcondon

CONTRIBUTING.md

@@ -13,7 +13,7 @@ There's a chance your idea is already on our roadmap, which is available at http
 [#dataverse IRC channel]: http://chat.dataverse.org
 [logged]: http://irclog.iq.harvard.edu/dataverse/today
 [issue tracker]: https://github.com/IQSS/dataverse/issues
-[@dataverseorg]: http://twitter.com/dataverseorg
+[@dataverseorg]: https://twitter.com/dataverseorg
 [Functional Requirements Document (FRD for short)]: https://docs.google.com/document/d/1PRyAlP6zlUlUuHfgyUezzuaVQ4JnapvgtGWo0o7tLEs/edit?usp=sharing
 [Balsamiq]: https://iqssharvard.mybalsamiq.com/projects
 [Functional Requirements Document folder on Google Drive]: https://drive.google.com/folderview?id=0B3_V6vFxEcx-fl92ek92OG1nTmhQenBRX1Z4OVJBLXpURmh2d2RyX1NZRUp6YktaYUU5YTA&usp=sharing
@@ -44,7 +44,7 @@ You can attach certain files (images, screenshots, logs, etc.) by dragging and d
 
 ## Documentation
 
-The source for the documentation at http://guides.dataverse.org is in the GitHub repo under the "[doc][]" folder. If you find a typo or inaccuracy or something to clarify, please send us a pull request! For more on the tools used to write docs, please see the [documentation][] section of the Developer Guide.
+The source for the documentation at http://guides.dataverse.org/en/latest/ is in the GitHub repo under the "[doc][]" folder. If you find a typo or inaccuracy or something to clarify, please send us a pull request! For more on the tools used to write docs, please see the [documentation][] section of the Developer Guide.
 
 [doc]: https://github.com/IQSS/dataverse/tree/develop/doc/sphinx-guides/source
 [documentation]: http://guides.dataverse.org/en/latest/developers/documentation.html

ISSUE_TEMPLATE.md

@@ -0,0 +1 @@
+Thank you for contributing an issue to the Dataverse Project! If this is a bug report, please let us know when the issue occurs, which page it occurs on, to whom it occurs, and which version of Dataverse you're using. If this is a feature request, please let us know what you'd like to see and give us some context - what kind of user is the feature intended for, and what inspired the request? No matter the issue, screenshots are always welcome.

doc/Architecture/Authentication-oauth.puml

@@ -0,0 +1,3 @@
+@startuml
+
+@enduml

doc/Architecture/Workflow/classes.puml

@@ -0,0 +1,116 @@
+@startuml
+' Macro to mark classes you've already implemented
+!define DONE(NAME) "NAME ✅" as NAME
+
+class DONE(DvObject) <<entity>>
+class DONE(DvObjectContainer) <<entity>>
+class DONE(Dataverse) <<entity>>
+class Dataset <<entity>>
+
+Dataset --|> DvObjectContainer
+DvObjectContainer --|>DvObject
+Dataverse -up-|> DvObjectContainer
+DvObject o--> DvObjectContainer: parent
+
+class DONE(Workflow) <<entity>> {
+  id
+  name
+  description
+}
+
+class DONE(WorkflowStepData) <<entity>> {
+  providerId: String
+  stepId: String
+  parameters: Map<String,String>
+}
+
+class WorkflowBean<In Progress> <<bean>> {
+  getWorkflows()
+  getWorkflow(id)
+  deleteWorkflow(id)
+  saveWorkflow(w)
+  resumeWorkflow(pwf)
+  ... not implemented ...
+  getStepProvider(id)
+}
+
+class DONE(WorkflowContext) {
+  r:DataverseRequest
+  d:Dataset
+  invocationId:UUID
+  versionData
+  isMinorRelease()
+}
+
+class DONE(PendingWorkflow) <<entity>> {
+  externalId: UUID
+  workflow: Workflow
+  pendingStepIdx: int
+  localData: DATA
+  request: DataverseRequest
+  dataset: Dataset
+}
+
+interface DONE(WorkflowStepSPI) {
+  id
+  getStep(stepId, parameters):Step
+}
+
+interface DONE(WorkflowStep) {
+  run( WorkflowContext ): WorkflowStepResult
+  resume( WorkflowContext ): WorkflowStepResult
+  rollback( WorkflowContext  )
+}
+
+class DONE(WorkflowStepResult) <<abstract>>
+class DONE(OK) <<singleton>>
+class DONE(Pending){
+  localData
+}
+class DONE(Failure) {
+  reason:Throwable
+}
+
+package engine.command {
+  class PublishDatasetCommand
+  class ResumeWorkflowCommand
+}
+
+package api {
+  class WorkflowStepResponse <<endpoint>> {
+    POST /step/${externalId}
+  }
+
+  class DONE(WorkflowManagementEndpoint) <<endpoint>> {
+    POST add
+    GET list
+    DELETE id
+    GET pendingWorkflows
+  }
+}
+
+OK -up-|> WorkflowStepResult
+Pending -up-|> WorkflowStepResult
+Failure -up-|> WorkflowStepResult
+
+PendingWorkflow o--> Workflow
+PendingWorkflow o--> WorkflowStepData
+PendingWorkflow o--> Dataset
+Workflow "1" *--> "1..*" WorkflowStepData: <<ordered>>
+WorkflowStepSPI ..> WorkflowStep: creates
+WorkflowStep ..> WorkflowStepResult: creates
+WorkflowStepResponse ..> PendingWorkflow : invokes
+WorkflowBean *--> WorkflowStepSPI
+WorkflowBean *--> Workflow
+
+PublishDatasetCommand ..> Workflow : uses
+PublishDatasetCommand ..> Dataset : uses
+PublishDatasetCommand ..> WorkflowBean : uses
+
+ResumeWorkflowCommand ..> Workflow : uses
+ResumeWorkflowCommand ..> Dataset : uses
+ResumeWorkflowCommand ..> WorkflowBean : uses
+
+PendingWorkflow  ..> WorkflowContext: <<contains>>
+
+@enduml

doc/Architecture/Workflow/classes.svg

@@ -0,0 +1,3 @@
+{
+  "reasonForReturn": "You forgot to upload any files."
+}

doc/Architecture/update-user-account-info.png

@@ -4,19 +4,20 @@
 
 @font-face {
   font-family: "fontcustom";
-  src: url("./fontcustom/fontcustom_0cdeefae934823416d24b6c2132ac702.eot");
-  src: url("./fontcustom/fontcustom_0cdeefae934823416d24b6c2132ac702.eot?#iefix") format("embedded-opentype"),
-       url("./fontcustom/fontcustom_0cdeefae934823416d24b6c2132ac702.woff") format("woff"),
-       url("./fontcustom/fontcustom_0cdeefae934823416d24b6c2132ac702.ttf") format("truetype"),
-       url("./fontcustom/fontcustom_0cdeefae934823416d24b6c2132ac702.svg#fontcustom") format("svg");
+  src: url("./fontcustom/fontcustom_fb6bd74e6004cae7db6ffae62177daaf.eot");
+  src: url("./fontcustom/fontcustom_fb6bd74e6004cae7db6ffae62177daaf.eot?#iefix") format("embedded-opentype"),
+       url("./fontcustom/fontcustom_fb6bd74e6004cae7db6ffae62177daaf.woff2") format("woff2"),
+       url("./fontcustom/fontcustom_fb6bd74e6004cae7db6ffae62177daaf.woff") format("woff"),
+       url("./fontcustom/fontcustom_fb6bd74e6004cae7db6ffae62177daaf.ttf") format("truetype"),
+       url("./fontcustom/fontcustom_fb6bd74e6004cae7db6ffae62177daaf.svg#fontcustom") format("svg");
   font-weight: normal;
   font-style: normal;
 }
 
 @media screen and (-webkit-min-device-pixel-ratio:0) {
   @font-face {
     font-family: "fontcustom";
-    src: url("./fontcustom/fontcustom_0cdeefae934823416d24b6c2132ac702.svg#fontcustom") format("svg");
+    src: url("./fontcustom/fontcustom_fb6bd74e6004cae7db6ffae62177daaf.svg#fontcustom") format("svg");
   }
 }
 
@@ -34,6 +35,7 @@
 .icon-image:before,
 .icon-network:before,
 .icon-other:before,
+.icon-package:before,
 .icon-tabular:before,
 .icon-unlock:before,
 .icon-video:before {
@@ -62,6 +64,7 @@
 .icon-image:before { content: "\f103"; }
 .icon-network:before { content: "\f10c"; }
 .icon-other:before { content: "\f10d"; }
+.icon-package:before { content: "\f10f"; }
 .icon-tabular:before { content: "\f108"; }
 .icon-unlock:before { content: "\f10e"; }
 .icon-video:before { content: "\f109"; }