Refine the consistency of Product import actions #241

Signed-off-by: tdruez <[email protected]>

Author: tdruez

dejacode/static/css/dejacode_bootstrap.css

@@ -590,10 +590,12 @@ div.awesomplete {
 [data-bs-theme=dark] .awesomplete > ul {
   background: var(--bs-black);
 }
-
 #div_id_component .awesomplete {
   display: inline-block !important;
 }
+label.requiredField {
+  font-weight: bolder;
+}
 
 /* -- Products comparison -- */
 body.product-comparison tr.unchanged {

dje/tasks.py

@@ -197,7 +197,7 @@ def pull_project_data_from_scancodeio(scancodeproject_uuid):
     )
 
     if scancode_project.type == scancode_project.ProjectType.LOAD_SBOMS:
-        notification_verb = "Load Packages from SBOMs"
+        notification_verb = "Import SBOM"
     else:
         notification_verb = "Import packages from ScanCode.io"
 

docs/reference-1.rst

@@ -5,7 +5,7 @@ Reference 1 - Declared License Expression and License Clarity Scoring
 =====================================================================
 
 When you scan a Package from DejaCode, you can view the Scan Results in a
-:guilabel:`Action` tab on the Package details user view. DejaCode presents a selection of
+:guilabel:`Actions` tab on the Package details user view. DejaCode presents a selection of
 scan details with an emphasis on license detection. You can also download the
 complete :guilabel:`Scan Results` in .json format.
 

docs/tutorial-1.rst

@@ -29,8 +29,8 @@ Alternatively, you can conveniently download one of the provided examples from
 the following
 `GitHub repository <https://github.com/aboutcode-org/dejacode/tree/main/docs/sboms/>`_.
 
-On the Product details page, from the :guilabel:`Action` dropdown, select
-:guilabel:`Load Packages from SBOMs`:
+On the Product details page, from the :guilabel:`Actions` dropdown, select
+:guilabel:`Import SBOM`:
 
 * Click the :guilabel:`Choose File` button on the **SBOM file or zip archive** field.
 * Select your SBOM (.cdx.json or .spdx.json) and click the :guilabel:`Open` button.

docs/tutorial-2.rst

@@ -21,7 +21,7 @@ Click the green :guilabel:`Add` button.
 
 DejaCode presents the new Package.
 
-- Refresh your browser page to see the :guilabel:`Action` tab.
+- Refresh your browser page to see the :guilabel:`Actions` tab.
 - Explore the scan results.
 - Select values to apply to the new Package definition, such as one or more licenses,
   a Copyright statement, and a Primary langauge.
@@ -109,7 +109,7 @@ Improve Package Data by Scanning
 Select :guilabel:`Packages` from the main menu bar.
 
 Identify and select a Package that needs to be improved.
-Click the :guilabel:`Action` button on the Package details form.
+Click the :guilabel:`Actions` button on the Package details form.
 
 Optionally follow the progress of the Scan by selecting the :guilabel:`Scans`
 option from the :guilabel:`Tools` dropdown on the main menu bar.

docs/tutorial-4-vulnerabilities.rst

@@ -26,8 +26,8 @@ Load Scan Results to your Product
 
    `<https://github.com/aboutcode-org/dejacode/tree/main/docs/sboms/starship_engine_2.0_scan_results.json>`_.
 
-2. On the Product details page, from the :guilabel:`Action` dropdown, select
-   :guilabel:`Import from Scan`:
+2. On the Product details page, from the :guilabel:`Actions` dropdown, select
+   :guilabel:`Import ScanCode scan results`:
 
    * Click the :guilabel:`Choose File` button under the **Upload file** field.
    * Select the **starship_engine_2.0_scan_results.json** file and click the

docs/tutorial-5-sboms.rst

@@ -27,8 +27,8 @@ Load an SBOM to your Product
 
    `<https://github.com/aboutcode-org/dejacode/raw/refs/heads/main/docs/sboms/storm-core-1.0.1.cdx.json.zip>`_.
 
-2. On the Product details page, from the :guilabel:`Action` dropdown, select
-   :guilabel:`Load Packages from SBOMs`:
+2. On the Product details page, from the :guilabel:`Actions` dropdown, select
+   :guilabel:`Import SBOM`:
 
    * Click the Browse field beneath :guilabel:`SBOM file or zip archive`
    * Select the **storm-core-1.0.cdx.json** file and leave the additional options
@@ -46,7 +46,7 @@ Load an SBOM to your Product
 .. image:: images/tutorial-5-sboms/inventory-tab-1.jpg
 
 5. You can enrich the data provided by your supplier,
-   From the :guilabel:`Action` dropdown, select
+   From the :guilabel:`Actions` dropdown, select
    :guilabel:`Improve Packages from PurlDB`:
 
 .. image:: images/tutorial-5-sboms/improve-packages-from-purldb.jpg

product_portfolio/api.py

@@ -349,7 +349,7 @@ def perform_create(self, serializer):
     @action(detail=True, methods=["post"], serializer_class=LoadSBOMsFormSerializer)
     def load_sboms(self, request, *args, **kwargs):
         """
-        Load Packages from SBOMs.
+        Import SBOM.
 
         DejaCode supports the following SBOM formats:
         * CycloneDX BOM as JSON bom.json and .cdx.json,

product_portfolio/forms.py

@@ -535,7 +535,10 @@ class Meta(BaseAddToProductForm.Meta):
 
 
 class ImportFromScanForm(forms.Form):
-    upload_file = SmartFileField(extensions=["json"])
+    upload_file = SmartFileField(
+        label=_("Scan results JSON file"),
+        extensions=["json"],
+    )
     create_codebase_resources = forms.BooleanField(
         label=_('Create Codebase Resources (from <code>"files"</code>)'),
         required=False,
@@ -566,7 +569,7 @@ def __init__(self, user, *args, **kwargs):
     @property
     def helper(self):
         helper = FormHelper()
-        helper.add_input(Submit("import", "Import"))
+        helper.add_input(Submit("submit", "Import", css_class="btn-success"))
         return helper
 
     def save(self, product):
@@ -636,7 +639,7 @@ def helper(self):
         helper.form_method = "post"
         helper.form_id = "import-manifest-form"
         helper.attrs = {"autocomplete": "off"}
-        helper.add_input(Submit("submit", "Load Packages", css_class="btn-success"))
+        helper.add_input(Submit("submit", "Import", css_class="btn-success"))
         return helper
 
     def submit(self, product, user):

product_portfolio/templates/product_portfolio/import_from_scan.html

@@ -3,7 +3,7 @@
 {% load crispy_forms_tags %}
 
 {% block page_title %}
-  Import from Scan
+  Import ScanCode scan results
 {% endblock %}
 
 {% block content %}
@@ -17,7 +17,7 @@
             <a href="{{ product.get_absolute_url }}">{{ product }}</a>
           </div>
           <h1 class="header-title">
-            Import from Scan
+            Import ScanCode scan results
           </h1>
         </div>
       </div>
@@ -37,15 +37,15 @@ <h1 class="header-title">
   </div>
 
   <div class="alert alert-dark bg-body-tertiary">
-    <h5>Option 1: From a ScanCode-toolkit scan output</h5>
+    <h5>Option 1: from a ScanCode-toolkit scan output</h5>
     <div class="mb-2">
       Upload a ScanCode-toolkit JSON output file, generated with <strong>version 31.2.3 or later</strong>, the following <strong>options are mandatory</strong>:
     </div>
     <kbd>$ scancode --copyright --license --info --package --json {file_output.json} {input_directory}</kbd>
   </div>
 
   <div class="alert alert-dark bg-body-tertiary">
-    <h5>Option 2: From ScanCode.io pipeline results</h5>
+    <h5>Option 2: from ScanCode.io pipeline results</h5>
     <p class="mb-1">
       Upload a ScanCode.io JSON output file, <strong>generated with one of the following pipelines:</strong>
     </p>