hansva commented on code in PR #9224: URL: https://github.com/apache/hop/pull/9224#discussion_r4452199147
########## docs/hop-user-manual/modules/ROOT/pages/pipeline/run-preview-debug-pipeline.adoc: ########## @@ -70,22 +70,47 @@ Hover your mouse over the red error triangle to take a quick peek at the error m image::hop-gui/pipeline/failed-pipeline.png[Failed pipeline,75%,align="left"] After each run the execution results are displayed in the panel on the bottom of your window. -The Execution Results contains two tabs: +The panel has these tabs: -* Transform Metrics -* Logging +* *Logging*: the log of the pipeline. +* *Metrics*: the metrics of each transform. +* *Problems*: the results of the checks of the pipeline and of the linter. +* *Revisions*: the git history of the pipeline file, when Git is enabled. -The Transform Metrics tab displays metrics per transform. +The same tabs are shown for a workflow, see xref:workflow/run-debug-workflow.adoc[Run and Debug a Workflow]. -image::hop-gui/pipeline/transform-metrics-pipeline.png[Transform Metrics pipeline,75%,align="left"] +=== Logging + +The Logging tab displays the log of the pipeline according to the log level chosen on execution. + +image::hop-gui/pipeline/logging-pipeline.png[Logging pipeline,75%,align="left"] + +=== Metrics + +The Metrics tab displays metrics per transform. + +image::hop-gui/pipeline/transform-metrics-pipeline.png[Metrics pipeline,75%,align="left"] Following metrics are displayed: include::../snippets/pipeline-metrics-table.adoc[] -The logging tab displays the log of the pipeline according to the log level chosen on execution. +=== Problems -image::hop-gui/pipeline/logging-pipeline.png[Logging pipeline,75%,align="left"] +The Problems tab lists the remarks of *Verify this pipeline* on the toolbar and, when the xref:linting/index.adoc[linter] is switched on, its findings for the file, next to each other. +Double-click a remark to open the transform it is about. +The toolbar of the tab can collapse and expand all remarks, and *Force refresh* clears the database cache and checks the pipeline again. + +image::hop-gui/pipeline/problems-pipeline.png[Problems pipeline,75%,align="left"] + +=== Revisions + +The Revisions tab lists the commits of the pipeline file, with the columns *Commit*, *Author*, *Date* and *Message*. Review Comment: The column order is the other way around. `BaseRevisionDelegate` builds the table as *Message*, *Author*, *Date*, *Commit*, with Message as the wide column (`plugins/misc/git/src/main/java/org/apache/hop/git/BaseRevisionDelegate.java`, the `revisionColumns` array). ########## docs/hop-user-manual/modules/ROOT/pages/pipeline/run-preview-debug-pipeline.adoc: ########## @@ -70,22 +70,47 @@ Hover your mouse over the red error triangle to take a quick peek at the error m image::hop-gui/pipeline/failed-pipeline.png[Failed pipeline,75%,align="left"] After each run the execution results are displayed in the panel on the bottom of your window. -The Execution Results contains two tabs: +The panel has these tabs: -* Transform Metrics -* Logging +* *Logging*: the log of the pipeline. +* *Metrics*: the metrics of each transform. +* *Problems*: the results of the checks of the pipeline and of the linter. +* *Revisions*: the git history of the pipeline file, when Git is enabled. -The Transform Metrics tab displays metrics per transform. +The same tabs are shown for a workflow, see xref:workflow/run-debug-workflow.adoc[Run and Debug a Workflow]. -image::hop-gui/pipeline/transform-metrics-pipeline.png[Transform Metrics pipeline,75%,align="left"] +=== Logging + +The Logging tab displays the log of the pipeline according to the log level chosen on execution. + +image::hop-gui/pipeline/logging-pipeline.png[Logging pipeline,75%,align="left"] + +=== Metrics + +The Metrics tab displays metrics per transform. + +image::hop-gui/pipeline/transform-metrics-pipeline.png[Metrics pipeline,75%,align="left"] Following metrics are displayed: include::../snippets/pipeline-metrics-table.adoc[] -The logging tab displays the log of the pipeline according to the log level chosen on execution. +=== Problems -image::hop-gui/pipeline/logging-pipeline.png[Logging pipeline,75%,align="left"] +The Problems tab lists the remarks of *Verify this pipeline* on the toolbar and, when the xref:linting/index.adoc[linter] is switched on, its findings for the file, next to each other. Review Comment: - The linter is a marketplace plugin (`hop-misc-lint`) and isn't in the standard client, see the Installing section of `linting/index.adoc`. Suggest: "when the linter is installed and switched on". - As written, it sounds like the tab fills only after *Verify this pipeline*. `linting/index.adoc` says lint findings appear as soon as the file has been linted (when it is opened, saved or edited), and Verify adds its remarks to them. Please make the two pages say the same thing. ########## docs/hop-user-manual/modules/ROOT/pages/workflow/run-debug-workflow.adoc: ########## @@ -57,4 +57,4 @@ Make sure your configuration is selected and hit 'Launch'. image::getting-started/getting-started-run-workflow-with-config.png[Hop - New Workflow With Config Dialog,75%,align="left"] This workflow with our very basic pipeline should execute in less than one second. -You'll now have the execution results pane which again looks very similar to the pipeline execution results. +You'll now have the execution results pane, with the same tabs as for a pipeline: *Logging*, *Metrics*, *Problems* and *Revisions*. On the Metrics tab a workflow shows a row for each action that ran, with among others its *Result*, *Reason* and *Duration*. The Problems tab lists the remarks of *Verify this workflow* and the findings of the linter. See xref:pipeline/run-preview-debug-pipeline.adoc#_running_a_pipeline[Running a pipeline] for the four tabs. Review Comment: Could you split this into one sentence per line, like the pipeline page? It keeps future diffs readable. Also, `#_running_a_pipeline` lands at the start of the run section. Linking to the new tab subsections, or adding an anchor above the tab list, would take readers straight to the four tabs. ########## docs/hop-user-manual/modules/ROOT/pages/pipeline/run-preview-debug-pipeline.adoc: ########## @@ -70,22 +70,47 @@ Hover your mouse over the red error triangle to take a quick peek at the error m image::hop-gui/pipeline/failed-pipeline.png[Failed pipeline,75%,align="left"] After each run the execution results are displayed in the panel on the bottom of your window. -The Execution Results contains two tabs: +The panel has these tabs: -* Transform Metrics -* Logging +* *Logging*: the log of the pipeline. +* *Metrics*: the metrics of each transform. +* *Problems*: the results of the checks of the pipeline and of the linter. +* *Revisions*: the git history of the pipeline file, when Git is enabled. -The Transform Metrics tab displays metrics per transform. +The same tabs are shown for a workflow, see xref:workflow/run-debug-workflow.adoc[Run and Debug a Workflow]. -image::hop-gui/pipeline/transform-metrics-pipeline.png[Transform Metrics pipeline,75%,align="left"] +=== Logging + +The Logging tab displays the log of the pipeline according to the log level chosen on execution. + +image::hop-gui/pipeline/logging-pipeline.png[Logging pipeline,75%,align="left"] + +=== Metrics + +The Metrics tab displays metrics per transform. + +image::hop-gui/pipeline/transform-metrics-pipeline.png[Metrics pipeline,75%,align="left"] Following metrics are displayed: include::../snippets/pipeline-metrics-table.adoc[] -The logging tab displays the log of the pipeline according to the log level chosen on execution. +=== Problems -image::hop-gui/pipeline/logging-pipeline.png[Logging pipeline,75%,align="left"] +The Problems tab lists the remarks of *Verify this pipeline* on the toolbar and, when the xref:linting/index.adoc[linter] is switched on, its findings for the file, next to each other. +Double-click a remark to open the transform it is about. +The toolbar of the tab can collapse and expand all remarks, and *Force refresh* clears the database cache and checks the pipeline again. + +image::hop-gui/pipeline/problems-pipeline.png[Problems pipeline,75%,align="left"] + +=== Revisions + +The Revisions tab lists the commits of the pipeline file, with the columns *Commit*, *Author*, *Date* and *Message*. +It is only shown when Git is enabled in the xref:hop-gui/perspective-configuration.adoc[configuration] and the project is a git repository, see xref:hop-gui/hop-gui-git.adoc[Working with git]. Review Comment: Two things on this line: 1. `hop-gui/perspective-configuration.adoc` doesn't describe the git switch. The *Enable the git plugin* option is documented in `hop-gui/hop-gui-git.adoc`, under Git Configuration options. Please link there. 2. "Only shown when ... the project is a git repository" is stricter than the code. `createRevisionsTab` only checks that the git plugin is enabled and a Git instance exists. A file outside the repository still gets the tab, with the "is not in the git repository" message (`Revisions.Message.OutsideRepository`). Could you add that case to the next line, next to "not saved yet" and "no commit yet"? -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
