Skip to content

docs: update Errors section to Messages in Web UI tutorial #2066

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
dikshaa2909 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: update Errors section to Messages in Web UI tutorial #2066

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs/images/tutorial-web-ui-messages-list.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
22 changes: 16 additions & 6 deletions docs/tutorial_web_ui_review_scan_results.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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
-----------------
Expand Down