diff --git a/docs/source/_static/data_request_community_repo.png b/docs/source/_static/data_request_community_repo.png new file mode 100644 index 00000000..a3a2e1a6 Binary files /dev/null and b/docs/source/_static/data_request_community_repo.png differ diff --git a/docs/source/_static/data_request_form.png b/docs/source/_static/data_request_form.png new file mode 100644 index 00000000..17e15527 Binary files /dev/null and b/docs/source/_static/data_request_form.png differ diff --git a/docs/source/_static/data_request_issues.png b/docs/source/_static/data_request_issues.png new file mode 100644 index 00000000..81975c7c Binary files /dev/null and b/docs/source/_static/data_request_issues.png differ diff --git a/docs/source/_static/data_request_selector.png b/docs/source/_static/data_request_selector.png new file mode 100644 index 00000000..8752198e Binary files /dev/null and b/docs/source/_static/data_request_selector.png differ diff --git a/docs/source/_static/data_request_submitted.png b/docs/source/_static/data_request_submitted.png new file mode 100644 index 00000000..648b7ec7 Binary files /dev/null and b/docs/source/_static/data_request_submitted.png differ diff --git a/docs/source/system_reference_guide/faq.rst b/docs/source/system_reference_guide/faq.rst index 7c0d2b41..e2ae1f09 100644 --- a/docs/source/system_reference_guide/faq.rst +++ b/docs/source/system_reference_guide/faq.rst @@ -9,3 +9,4 @@ FAQ faq/import_granules.ipynb faq/jupyter_server.ipynb faq/umf.ipynb + faq/request_data.ipynb \ No newline at end of file diff --git a/docs/source/system_reference_guide/faq/request_data.ipynb b/docs/source/system_reference_guide/faq/request_data.ipynb index a815d8fd..0e6a0749 100644 --- a/docs/source/system_reference_guide/faq/request_data.ipynb +++ b/docs/source/system_reference_guide/faq/request_data.ipynb @@ -4,7 +4,7 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "# Request Data\n", + "# How do I request new data to be available in MAAP? \n", "\n", "Authors: Emile Tenezakis (DevSeed), Sheyenne Kirkland (UAH)\n", "\n", @@ -24,13 +24,21 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "To access the form, users will go to [MAAP's Community Github repository](https://github.com/MAAP-Project/Community/issues/new/choose). You can either click on the link, or go to \"Issues\" and select \"New issue\" from the Community repository.\n", + "### Direct access link\n", "\n", - "![community_repo](../../_static/community_repo.png)\n", + "You can directly access the form through [this link](https://github.com/MAAP-Project/Community/issues/new?assignees=freitagb%2C+wildintellect&labels=MSFC&projects=&template=data_request.yaml&title=%5BData%5D%3A).\n", "\n", - "There are three different options for users to open an issue. To request data, select \"Get Started\" next to \"Data Request\".\n", + "### Navigate manually to the form\n", "\n", - "![data_request_getstarted](../../_static/data_request_getstarted.png)" + "The form is hosted as an \"issue template\" in the [MAAP Community Github repository](https://github.com/MAAP-Project/Community). Navigate to this repository. There, go to \"Issues\", and then click on \"New Issue\". There are three different options for users to open an issue. To request data, select \"Get Started\" next to \"Data Request\".\n", + "\n", + "![dr_community_repo](../../_static/data_request_community_repo.png)\n", + "\n", + "\n", + "![dr_selector](../../_static/data_request_selector.png)\n", + "\n", + "\n", + "![dr_issues](../../_static/data_request_issues.png) " ] }, { @@ -44,11 +52,9 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "Once you select \"Get started\", you'll be taken to the form. There are several fields to complete, some of which are required (marked with a red *) and some optional. This helps ensure that the data team recieves enough information.\n", + "Once you opened the form, you will see several fields to complete, some of which are required (marked with a red *) and some optional. This helps ensure that the data team recieves enough information. Assignees and labels are also automatically included, so all users have to do is enter information about the data.\n", "\n", - "Assignees and labels are also automatically included, so all users have to do is enter information about the data.\n", - "\n", - "We've provided screenshots of a sample form below:" + "![dr_form](../../_static/data_request_form.png)" ] }, { @@ -59,11 +65,13 @@ ] }, { - "cell_type": "code", - "execution_count": null, + "cell_type": "markdown", "metadata": {}, - "outputs": [], - "source": [] + "source": [ + "Click on 'Submit new issue'. We've provided a screenshot of an example submitted issue below :\n", + "\n", + "![submitted_issue](../../_static/data_request_submitted.png)" + ] } ], "metadata": {