Skip to content

Commit 5b761c7

Browse files
authored
Merge pull request #338 from MAAP-Project/newdata-form-sk
Documentation for Data Request Issue Form
2 parents 52a43d2 + 44f77f0 commit 5b761c7

File tree

8 files changed

+99
-31
lines changed

8 files changed

+99
-31
lines changed
206 KB
Loading
206 KB
Loading
236 KB
Loading
134 KB
Loading
136 KB
Loading

docs/source/system_reference_guide/faq.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,4 @@ FAQ
88
faq/copy_earthdata.ipynb
99
faq/import_granules.ipynb
1010
faq/jupyter_server.ipynb
11-
faq/umf.ipynb
11+
faq/request_data.ipynb
Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
{
2+
"cells": [
3+
{
4+
"cell_type": "markdown",
5+
"metadata": {},
6+
"source": [
7+
"# How do I request new data to be available in MAAP? \n",
8+
"\n",
9+
"Authors: Emile Tenezakis (DevSeed), Sheyenne Kirkland (UAH)\n",
10+
"\n",
11+
"Date: September 27, 2023\n",
12+
"\n",
13+
"Description: in this example, we'll show you how to access MAAP's Data Request Form in Github, as well as provide an example on how to fill out and submit it. The purpose of this form is to provide a way for users to request data to be ingested into the MAAP platform for use."
14+
]
15+
},
16+
{
17+
"cell_type": "markdown",
18+
"metadata": {},
19+
"source": [
20+
"## Accessing the Form"
21+
]
22+
},
23+
{
24+
"cell_type": "markdown",
25+
"metadata": {},
26+
"source": [
27+
"### Direct Access Link\n",
28+
"\n",
29+
"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",
30+
"\n",
31+
"### Navigate Manually to the Form\n",
32+
"\n",
33+
"The form is hosted as an \"issue template\" in the [MAAP Community Github repository](https://github.com/MAAP-Project/Community). Navigate to this repository. From 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",
34+
"\n",
35+
"![dr_community_repo](../../_static/data_request_community_repo.png)\n",
36+
"\n",
37+
"\n",
38+
"![dr_selector](../../_static/data_request_selector.png)\n",
39+
"\n",
40+
"\n",
41+
"![dr_issues](../../_static/data_request_issues.png) "
42+
]
43+
},
44+
{
45+
"cell_type": "markdown",
46+
"metadata": {},
47+
"source": [
48+
"## Filling out the Form"
49+
]
50+
},
51+
{
52+
"cell_type": "markdown",
53+
"metadata": {},
54+
"source": [
55+
"Once you open 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",
56+
"\n",
57+
"![dr_form](../../_static/data_request_form.png)"
58+
]
59+
},
60+
{
61+
"cell_type": "markdown",
62+
"metadata": {},
63+
"source": [
64+
"## Submission"
65+
]
66+
},
67+
{
68+
"cell_type": "markdown",
69+
"metadata": {},
70+
"source": [
71+
"Click on 'Submit new issue'. We've provided a screenshot of an example submitted issue below :\n",
72+
"\n",
73+
"![submitted_issue](../../_static/data_request_submitted.png)"
74+
]
75+
}
76+
],
77+
"metadata": {
78+
"kernelspec": {
79+
"display_name": "Python 3 (ipykernel)",
80+
"language": "python",
81+
"name": "python3"
82+
},
83+
"language_info": {
84+
"codemirror_mode": {
85+
"name": "ipython",
86+
"version": 3
87+
},
88+
"file_extension": ".py",
89+
"mimetype": "text/x-python",
90+
"name": "python",
91+
"nbconvert_exporter": "python",
92+
"pygments_lexer": "ipython3",
93+
"version": "3.10.8"
94+
}
95+
},
96+
"nbformat": 4,
97+
"nbformat_minor": 4
98+
}

docs/source/system_reference_guide/faq/umf.ipynb

Lines changed: 0 additions & 30 deletions
This file was deleted.

0 commit comments

Comments
 (0)