Skip to content
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.

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

Getting started overhaul #184

Merged
merged 41 commits into from
May 18, 2023
Merged

Getting started overhaul #184

merged 41 commits into from
May 18, 2023

Conversation

rtapella
Copy link
Collaborator

@rtapella rtapella commented May 1, 2023

Built preview:
https://docs.maap-project.org/en/getting-started-pr-branch/getting_started.html

Overhaul of all the Getting Started docs. This is a combo of:

  • the old GS docs
  • Alexey S's Quickstart Guide
  • new content and rewritten content
  • Emile's rewrite of the conda environment stuff

If you have time please go through the whole thing and try to follow the instructions. Some areas that need review:

  • About and the new overview docs
  • Jupyter interface overview section of "setting up your account and workspace"
  • MAAP storage options section of "setting up your account and workspace"
  • Using maap.py from a Python notebook needs some content to help get started in "Writing code"
  • Some helpful starter templates in "Writing code" (Sujen?)
  • working with GitLab and GitHub in "Writing code"
  • clean up the conda section and replace with Emile's new page if that makes more sense (delete content and reference the new section)
  • Registering an algorithm needs testing. Should be able to: 1. clone a demo algorithm 2. edit it 3. register it.
  • Run and monitor a job: update with new jobs UI

@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@rtapella rtapella marked this pull request as ready for review May 17, 2023 02:27
@wildintellect
Copy link
Collaborator

@rtapella I found it easier to read through the actual rendered site, so the comments are not inline with the notebooks, but they are in order and tag the relevant page/section.

https://docs.maap-project.org/en/getting-started-pr-branch/getting_started/maap_overview.html
confusing text, use of DPS before explaining DPS
RESTful API - no regular user needs to know that, that goes in the Reference section

https://docs.maap-project.org/en/getting-started-pr-branch/getting_started/getting_started.html
Callout with note section
Once your MAAP account is approved, you will receive an email notification using the address of your Earthdata Login account to let you know that your access is enabled.

Workspaces are effectively a Jupyter <- JupyterLab

the info in Stacks is not useful to the user, they want a link to the environments.yml files on github that explain what's in each env

https://docs.maap-project.org/en/getting-started-pr-branch/getting_started/getting_started.html#Jupyter-Interface-overview
Is this not in Jupyter standard docs?

https://docs.maap-project.org/en/getting-started-pr-branch/_images/storageoptions.png
(Custom) Files in the workspace -> is incorrect, the files do exist across workspaces for the workspace owner.

https://docs.maap-project.org/en/getting-started-pr-branch/getting_started/getting_started.html#Sharing-files:-my-public-bucket-and-shared-buckets
doesn't explain the difference between public-bucket (read-write) and shared (read-only)

https://docs.maap-project.org/en/getting-started-pr-branch/getting_started/writing_code.html#Writing-code-with-MAAP
which may be GitHub or MAAP GitLab. <- those are simply the top 2 suggested locations for storing git repos. names like git should be bolded or highlighted

GUI widget is mentioned but terminal is not?
nothing in here about tokens for pushing to gitlab or github

Algorithms run at scale in the MAAP must first be pushed to the MAAP GitLab in order to facilitate registration. <- this might not be true anymore, I think all public repos work in the 3.0 version ask Sujen

https://docs.maap-project.org/en/getting-started-pr-branch/getting_started/writing_code.html#Using-maap.py-to-access-MAAP-functionality-from-Python-notebooks
Doesn't explain what maap.py actually is, and when you might want to use it.

https://docs.maap-project.org/en/getting-started-pr-branch/getting_started/writing_code.html#Helpful-Templates-while-developing-Algorithms-in-MAAP
the current repo does not contain any examples of use to regular users
https://github.com/MAAP-Project/maap-repo-template feels more like an internal MAAP template for devs not users
A separate repo will need to be made for Algorithm template in order to allow use of github Template button. (https://github.com/MAAP-Project/dps-unit-test might be the better template to mention)

https://docs.maap-project.org/en/getting-started-pr-branch/getting_started/running_at_scale.html#Clone-a-test-algorithm
Makes it seem like you have to clone the repo
gets confusing when you get down to https://docs.maap-project.org/en/getting-started-pr-branch/getting_started/running_at_scale.html#Register-the-algorithm

https://docs.maap-project.org/en/getting-started-pr-branch/getting_started/running_at_scale.html#Pop-up
Code example isn't in a code block, impossible to read or copy

@rtapella
Copy link
Collaborator Author

Thank you Alex. I have implemented most of those changes. I added some new Git Issues in this repo for things I'd like to punt on for now so we can merge this PR.

Copy link
Collaborator

@wildintellect wildintellect left a comment

Choose a reason for hiding this comment

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

Good first pass for V3. Items not addressed yet are in new tickets #194 #195 #196

@rtapella rtapella merged commit fbf8d01 into develop May 18, 2023
@wildintellect wildintellect deleted the Getting-Started-pr-branch branch May 26, 2023 19:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants