Troubleshooting section

docs/source/index.rst

@@ -13,6 +13,7 @@ Welcome to the MAAP User Documentation!
   science_examples.rst
   technical_tutorials.rst
   system_reference.rst
+  troubleshooting_guides.rst
   release_notes.rst
 
 Indices and tables

docs/source/troubleshooting/account_not_activated.ipynb

@@ -0,0 +1,45 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "id": "58641795-4f3e-40af-9374-b882f2be6eb1",
+   "metadata": {},
+   "source": [
+    "# My Account is No Longer Activated"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "cd3c4962",
+   "metadata": {},
+   "source": [
+    "You may see an error message when logging in about your account not being \"activated.\" In this case, alert the MAAP support team via Slack or by sending an email to support@maap-project.org. Likely causes of this error include:\n",
+    "\n",
+    "1. **MAAP service outage** - if an operational outage has occurred in one of the MAAP subsystems such as the REST API or the SSO service, this will prevent the ADE from being able to validate the user's account status. The [MAAP Status Page](https://maap-project.github.io/maap-statuspage/) may help identify an outage.\n",
+    "2. **EarthData profile change** - if you changed your email or username in EarthData Login, this may cause a sign-in conflict, requiring a MAAP admin to re-sync your profile within the ADE.\n",
+    "3. **MAAP access suspension** - if your access to MAAP has been suspended (disabled), access will need to be re-activated by a MAAP admin before the ADE can be accessed. "
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.9.1"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}

docs/source/troubleshooting/dps_error_codes.ipynb

@@ -0,0 +1,51 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "id": "58641795-4f3e-40af-9374-b882f2be6eb1",
+   "metadata": {},
+   "source": [
+    "# Error Codes in DPS"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "cd3c4962",
+   "metadata": {},
+   "source": [
+    "Jobs run at scale in the DPS may fail for various reasons. Here are some of the common error codes and how to resolve those errors."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "b647510a",
+   "metadata": {},
+   "source": [
+    "error code | explanation | resolution\n",
+    "---------- | ----------- | ----------\n",
+    "exit code 143 | The system lost access to a resource due to [spot-instance interruption](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-interruptions.html) | Re-run the job(s) later or with a different resource\n"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.9.1"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}

docs/source/troubleshooting/kernel_resetting.ipynb

@@ -0,0 +1,43 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "id": "58641795-4f3e-40af-9374-b882f2be6eb1",
+   "metadata": {},
+   "source": [
+    "# Kernel resetting repeatedly"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "cd3c4962",
+   "metadata": {},
+   "source": [
+    "The underlying cause for this could be that you deleted the conda environment that you used to create the kernelspec you are trying to run with \n",
+    "\n",
+    "Resolution: Make sure the conda environment for the jupyter kernelspec still exists.\n"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.9.1"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}

docs/source/troubleshooting_guides.rst

@@ -0,0 +1,11 @@
+Troubleshooting Guides
+=======================================
+
+This section will help manage known issues and debugging tips.
+
+.. toctree::
+  :maxdepth: 2
+
+  troubleshooting/account_not_activated.ipynb
+  troubleshooting/dps_error_codes.ipynb
+  troubleshooting/kernel_resetting.ipynb