Merge pull request #390 from MAAP-Project/mlucas/revoke-docs

revoke docs | minor updates

docs/source/getting_started/running_at_scale.ipynb

@@ -80,7 +80,7 @@
     "\n",
     "The Jobs UI will let you run and monitor jobs easily. You can find full documentation in the system reference guide for [the Jobs UI](../system_reference_guide/jobsui.ipynb) or [using maap-py](../system_reference_guide/jobs_maappy.ipynb) with Python in the System Reference Guide FAQs.\n",
     "\n",
-    "![job_ui_access](../_static/jobs_ui_access.png)\n",
+    "![job_ui_access](../_static/jobs_ui/jobs_ui_access.png)\n",
     "\n",
     "Some alternative methods of running the job are found below.\n",
     "\n",

docs/source/system_reference_guide/ade_custom_extensions.rst

@@ -1,4 +1,4 @@
-ADE Custom Extensions
+Other Custom Extensions
 =======================================
 
 .. toctree::

docs/source/system_reference_guide/ade_custom_extensions/maap_help.ipynb

@@ -4,7 +4,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# Maap Help Jupyter Extension\n",
+    "# MAAP Help Jupyter Extension\n",
     "This Jupyter extension provides an interactive tutorial on a new user's first launch of the ADE and adds MAAP specific information to the help tab. The interactive tutorial can be accessed again from the help menu. "
    ]
   },

docs/source/system_reference_guide/jobsui.ipynb

@@ -19,7 +19,7 @@
     "\n",
     "1. From your workspace click on the __View & Submit Jobs__ card on the Launcher tab.\n",
     "\n",
-    "![job_ui_access](../_static/jobs_ui_access.png)\n"
+    "![job_ui_access](../_static/jobs_ui/jobs_ui_access.png)\n"
    ]
   },
   {
@@ -33,7 +33,7 @@
     "\n",
     "Users can sort jobs by queued, start, and end time in ascending/descending order. Users may use the search bar to filter the job list down to jobs containing the user-provided string in any of the fields shown.  \n",
     "\n",
-    "![jobs_ui_overview](../_static/jobs_ui_overview.png)\n",
+    "![jobs_ui_overview](../_static/jobs_ui/jobs_ui_overview.png)\n",
     "\n",
     "### Job Status\n",
     "Job status may be different between the HySDS Figaro job-monitoring dashboard and the Jobs UI. Below is a mapping of status terms:\n",
@@ -86,19 +86,19 @@
     ".. note::\n",
     "Experimental feature: The output data will be put into a folder named for your Algorithm and the Job Tag. You can use the same Job Tag on several jobs (e.g. in a batch) to group related output data in one place. In [maap.py submitJob](jobs_maappy.ipynb#Submit-a-Job) this is the `identifier` field when you use submitJob().\n",
     "\n",
-    "![jobs_ui_submit](../_static/jobs_ui_submit.png)\n",
+    "![jobs_ui_submit](../_static/jobs_ui/jobs_ui_submit.png)\n",
     "\n",
     "Algorithms may contain additional inputs that users may have to provide.\n",
     "\n",
-    "![jobs_ui_submit_detail](../_static/jobs_ui_submit_detail.png)\n",
+    "![jobs_ui_submit_detail](../_static/jobs_ui/jobs_ui_submit_detail.png)\n",
     "\n",
     "Once all inputs have been provided, the user may click __Submit Job__ to submit the job. If the job was submitted successfully, a toast will appear in the bottom right corner containing the unique job id. Please give the __Submit Job__ button a second to execute. \n",
     "\n",
-    "![jobs_ui_submit_toast](../_static/jobs_ui_submit_toast.png)\n",
+    "![jobs_ui_submit_toast](../_static/jobs_ui/jobs_ui_submit_toast.png)\n",
     "\n",
     "If the job failed to submit, a toast will appear indicating the job failed to submit.\n",
     "\n",
-    "![jobs_ui_failed_toast](../_static/jobs_ui_failed_toast.png)"
+    "![jobs_ui_failed_toast](../_static/jobs_ui/jobs_ui_failed_toast.png)"
    ]
   },
   {
@@ -110,7 +110,36 @@
     "\n",
     "Users may fill out the job submission form and - instead of submitting the job - click the __Copy Jupyter Notebook Code__ button to copy the __maap-py__ job submission command to their clipboard to then paste it into a Jupyter notebook.\n",
     "\n",
-    "![jobs_ui_copy_code](../_static/jobs_ui_copy_code.png)"
+    "![jobs_ui_copy_code](../_static/jobs_ui/jobs_ui_copy_code.png)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "84cf6298",
+   "metadata": {},
+   "source": [
+    "## Cancel Jobs\n",
+    "\n",
+    "Users may cancel queued or running jobs. Queued jobs that are cancelled will be deleted and no longer listed in the __View Jobs__ table. Running jobs that are cancelled will be stopped, but still viewable in the __View Jobs__ table. These jobs will have the status __job-revoked__.\n",
+    "\n",
+    ".. note::\n",
+    "Jobs that are listed as queued in the UI, then cancelled, may remain in the View Jobs table after the cancel request was submitted. This is due to a delay within the DPS between job state change and report of job state change. In these cases, the cancelled job was not really queued but had already started.\n",
+    "\n",
+    "1. In the View Jobs table, hover over the job entry you want to cancel to display the action bar.\n",
+    "\n",
+    "2. Click the cancel job button.\n",
+    "\n",
+    "![jobs_ui_revoke_job](../_static/jobs_ui/revoke_job.png)\n",
+    "\n",
+    "Once the cancel request is submitted, a toast will appear in the bottom right of the workspace indicating whether or not the request was successful.\n",
+    "\n",
+    "Successful submission:\n",
+    "![jobs_ui_revoke_success](../_static/jobs_ui/revoke_successful.png)\n",
+    "\n",
+    "Unsuccessful submission:\n",
+    "![jobs_ui_revoke_failed](../_static/jobs_ui/revoke_failed.png)\n",
+    "\n",
+    " "
    ]
   }
  ],