diff --git a/docs/images/tutorial-web-ui-messages-list.png b/docs/images/tutorial-web-ui-messages-list.png new file mode 100644 index 0000000000..7355c6ca95 Binary files /dev/null and b/docs/images/tutorial-web-ui-messages-list.png differ diff --git a/docs/tutorial_web_ui_review_scan_results.rst b/docs/tutorial_web_ui_review_scan_results.rst index 790401bb47..bc91f718a7 100644 --- a/docs/tutorial_web_ui_review_scan_results.rst +++ b/docs/tutorial_web_ui_review_scan_results.rst @@ -17,7 +17,7 @@ results using the ScanCode.io web interface. On the homepage, you can click on the project name in the summary table to access a detailed project output page. You can also click any of the numbers -underneath the **Packages**, **Resources**, or **Errors** fields to be directed +underneath the **Packages**, **Resources**, or **Messages** fields to be directed to the field's corresponding information. Further, clicking on the pipeline's execution status —**Success** in this case— expands some extra pipeline details, Resources status, and Run log. @@ -68,13 +68,23 @@ resources by **Programming Language**, **Mime Type**, **Holder**, **Copyright**, .. image:: images/tutorial-web-ui-resources-filter.png -Errors ------- +Messages +-------- In addition to discovered packages and codebase resources, the ScanCode.io -homepage shows the number of existing errors, which you can click for detailed -description of each error. +homepage shows the number of existing **Messages**, which you can click +to view detailed information. + +Messages can have different severity levels: + +- INFO +- WARNING +- ERROR + +The "Messages" counter replaces the older "Errors" section used in previous +versions of ScanCode.io. Project errors are now represented as messages +with severity set to ERROR. -.. image:: images/tutorial-web-ui-errors-list.png +.. image:: images/tutorial-web-ui-messages-list.png Other Information -----------------