-
Notifications
You must be signed in to change notification settings - Fork 13
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
Conversation
- placeholders on running at scale section
Section reorg
- also cleaned up writing code section code-blocks a bit
Getting started refresh
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
- it needs to be updated
Users shouldn't be expecting a response if they're not part of biomass or a known user in the community.
…roject/maap-documentation into Getting-Started-pr-branch
- added data catalog bullet point
*.ops.maap-project.org -> *.maap-project.org
@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 https://docs.maap-project.org/en/getting-started-pr-branch/getting_started/getting_started.html 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 https://docs.maap-project.org/en/getting-started-pr-branch/_images/storageoptions.png https://docs.maap-project.org/en/getting-started-pr-branch/getting_started/getting_started.html#Sharing-files:-my-public-bucket-and-shared-buckets https://docs.maap-project.org/en/getting-started-pr-branch/getting_started/writing_code.html#Writing-code-with-MAAP GUI widget is mentioned but terminal is not? 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 https://docs.maap-project.org/en/getting-started-pr-branch/getting_started/writing_code.html#Helpful-Templates-while-developing-Algorithms-in-MAAP https://docs.maap-project.org/en/getting-started-pr-branch/getting_started/running_at_scale.html#Clone-a-test-algorithm https://docs.maap-project.org/en/getting-started-pr-branch/getting_started/running_at_scale.html#Pop-up |
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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:
If you have time please go through the whole thing and try to follow the instructions. Some areas that need review: