Merge pull request #394 from MAAP-Project/develop

Periodic merge to master (release 3.1.5)
MAAP-Project · Apr 10, 2024 · 3416052 · 3416052
2 parents 76699b4 + 3e6c04e
commit 3416052
Show file tree

Hide file tree

Showing 47 changed files with 2,373 additions and 35 deletions.
diff --git a/README.md b/README.md
@@ -1,5 +1,5 @@
 # maap-documentation
-[![Documentation Status](https://readthedocs.org/projects/maap-project/badge/?version=latest)](https://maap-project.readthedocs.io/en/latest/?badge=latest)
+[![Documentation Status](https://readthedocs.org/projects/maap-project/badge/?version=latest)](https://maap-project.readthedocs.io/en/latest/?badge=latest) [![DOI](https://zenodo.org/badge/235617200.svg)](https://zenodo.org/doi/10.5281/zenodo.10499174)
 
 This repository serves as the technical documentation for interfacing with the MAAP services.
 

diff --git a/docs/source/_static/faq_images/import_granules.png b/docs/source/_static/faq_images/import_granules.png
diff --git a/docs/source/_static/faq_images/import_granules_1.png b/docs/source/_static/faq_images/import_granules_1.png
diff --git a/docs/source/_static/jobs_ui_access.png → ...source/_static/jobs_ui/jobs_ui_access.png b/docs/source/_static/jobs_ui_access.png → ...source/_static/jobs_ui/jobs_ui_access.png
diff --git a/docs/source/_static/jobs_ui_copy_code.png → ...rce/_static/jobs_ui/jobs_ui_copy_code.png b/docs/source/_static/jobs_ui_copy_code.png → ...rce/_static/jobs_ui/jobs_ui_copy_code.png
diff --git a/docs/source/_static/jobs_ui_failed_toast.png → .../_static/jobs_ui/jobs_ui_failed_toast.png b/docs/source/_static/jobs_ui_failed_toast.png → .../_static/jobs_ui/jobs_ui_failed_toast.png
diff --git a/docs/source/_static/jobs_ui_overview.png → ...urce/_static/jobs_ui/jobs_ui_overview.png b/docs/source/_static/jobs_ui_overview.png → ...urce/_static/jobs_ui/jobs_ui_overview.png
diff --git a/docs/source/_static/jobs_ui_submit.png → ...source/_static/jobs_ui/jobs_ui_submit.png b/docs/source/_static/jobs_ui_submit.png → ...source/_static/jobs_ui/jobs_ui_submit.png
diff --git a/.../source/_static/jobs_ui_submit_detail.png → ..._static/jobs_ui/jobs_ui_submit_detail.png b/.../source/_static/jobs_ui_submit_detail.png → ..._static/jobs_ui/jobs_ui_submit_detail.png
diff --git a/docs/source/_static/jobs_ui_submit_toast.png → .../_static/jobs_ui/jobs_ui_submit_toast.png b/docs/source/_static/jobs_ui_submit_toast.png → .../_static/jobs_ui/jobs_ui_submit_toast.png
diff --git a/docs/source/_static/jobs_ui/revoke_failed.png b/docs/source/_static/jobs_ui/revoke_failed.png
diff --git a/docs/source/_static/jobs_ui/revoke_job.png b/docs/source/_static/jobs_ui/revoke_job.png
diff --git a/docs/source/_static/jobs_ui/revoke_successful.png b/docs/source/_static/jobs_ui/revoke_successful.png
diff --git a/docs/source/getting_started/_static/storage_options_diagram.png b/docs/source/getting_started/_static/storage_options_diagram.png
diff --git a/docs/source/getting_started/getting_started.ipynb b/docs/source/getting_started/getting_started.ipynb
@@ -136,21 +136,22 @@
     "\n",
     "#### My root folder (fast cloud storage)\n",
     " - Your Jupyter home directory (`~`) is mounted to `/projects`.  Files in here persist across sessions and exist across your workspaces.\n",
-    "     - Use this for code-related items, smaller data storage\n",
-    "     - Git is more likely to behave predictably here compared to other storage\n",
+    "     - Use this for code-related items, smaller data storage (such as Jupyter Notebooks, Python/ R/ Markdown files, etc.)\n",
+    "     - Git is more likely to behave predictably here compared to other storage \n",
     "     - This is also the place to make persistent conda environments (covered in another section), but make sure to not make a conda env inside a git-tracked folder, or if you do add it to the .gitignore. If git is tracking an env, it could cause your workspace to crash. \n",
     " - Uses local (to Jupyter) file system; generally faster and more reliable for “normal” file operations, but expensive\n",
     "\n",
     "#### Large file storage: my-private-bucket\n",
     "`~/my-private-bucket` is an S3 bucket with persistent storage, but accessible only to you and others in a shared workspace.\n",
     " \n",
     " - Use for large data storage\n",
-    " - It will be slower than the root folder to copy and move files, which is why it is not ideal for storing smaller files that need to be read or written quickly\n",
+    " - It will be slower than the root folder to copy and move files, which is why it is not ideal for storing smaller files that need to be read or written quickly (e.g. Jupyter Notebooks)\n",
     "\n",
     "#### Sharing files: my-public-bucket and shared-buckets\n",
     "`~/my-public-bucket` is an S3 bucket with persistent storage. It is the same as `~/shared-buckets/<my_username>/` — anything you put in here will be accessible to other users via `~/shared-buckets/<my_username>` as a read-only file. Likewise, to find shared files from another user, look in `~/shared-buckets/<their_username>`.\n",
     "\n",
-    " - Use for large data storage for files that you want to share across workspaces\n",
+    " - Use for large data storage for files that you want to share across workspaces \n",
+    " - Public and shared buckets are not recommended for Jupyter Notebooks\n",
     "\n",
     "![Storage options diagram](_static/storage_options_diagram.png)\n",
     "\n",
@@ -161,9 +162,9 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python [conda env:root] *",
+   "display_name": "Python 3.12.0 64-bit",
    "language": "python",
-   "name": "conda-root-py"
+   "name": "python3"
   },
   "language_info": {
    "codemirror_mode": {
@@ -175,12 +176,17 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.7.8"
+   "version": "3.12.0"
   },
   "metadata": {
    "interpreter": {
     "hash": "31f2aee4e71d21fbe5cf8b01ff0e069b9275f58929596ceb00d14d90e3e16cd6"
    }
+  },
+  "vscode": {
+   "interpreter": {
+    "hash": "7500c3e1c7c786e4ba1e4b4eb7588219b4e35d5153674f92eb3a82672b534f6e"
+   }
   }
  },
  "nbformat": 4,

diff --git a/docs/source/getting_started/running_at_scale.ipynb b/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",