Skip to content

improve doc on data request form #339

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
smk0033 merged 1 commit into from
Sep 27, 2023
Merged

improve doc on data request form #339

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs/source/_static/data_request_community_repo.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/_static/data_request_form.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/_static/data_request_issues.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/_static/data_request_selector.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/_static/data_request_submitted.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/source/system_reference_guide/faq.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,4 @@ FAQ
faq/import_granules.ipynb
faq/jupyter_server.ipynb
faq/umf.ipynb
faq/request_data.ipynb
34 changes: 21 additions & 13 deletions docs/source/system_reference_guide/faq/request_data.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"cell_type": "markdown",
Copy link
Contributor Author

@emileten emileten Sep 27, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The purpose of this form is to provide a way for users to request data to be ingested into the MAAP STAC Catalog for use.

A question because it's still not 100% clear to me. Is this form encompassing both requests for (1) data storage (having the data in the MAAP S3 bucket) and (2) MAAP STAC metadata storage ? I was under the impression that no, this form is just for (1) and we want another one for (2).

If we want these processes to happen together though, we could use only this form, but maybe it has to be enriched (we can do that later) with information we will need to create the metadata.


Reply via ReviewNB

Copy link
Contributor Author

@emileten emileten Sep 27, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

cc @smk0033 @wildintellect

Copy link
Contributor

@smk0033 smk0033 Sep 27, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ohh yeah, I didn't think about S3, my mind automatically went to STAC for some reason. I'll wait for Alex to answer on that one

Copy link
Collaborator

@wildintellect wildintellect Sep 27, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This form is for "official" import to MAAP, aka STAC which implies it's already on S3 or a copy will be placed there.

Copy link
Collaborator

@wildintellect wildintellect Sep 27, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, eventually we'll need more info from users. This was step one. You can see what details to add is still being debated MAAP-Project/Community#712

"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",
Expand All @@ -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) "
]
},
{
Expand All @@ -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)"
]
},
{
Expand All @@ -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": {
Expand Down