Skip to content

Update “Errors” section to “Messages” in ScanCode.io Web UI tutorial #2118

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
Erianafranky wants to merge 1 commit into
base: main
Choose a base branch
from
+13 −5
Open

Update “Errors” section to “Messages” in ScanCode.io Web UI tutorial #2118

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
18 changes: 13 additions & 5 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,11 +68,19 @@ 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 messages, which you can click to view detailed
information.

Messages can have different severity levels such as INFO, WARNING, and ERROR.

.. note::

In previous versions of ScanCode.io, errors were displayed in a dedicated
“Errors” section. This has now been replaced by a more general “Messages”
system that includes INFO, WARNING, and ERROR levels.

.. image:: images/tutorial-web-ui-errors-list.png

Expand Down