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

[DOC] - Update end user conda-store tutorial with new UI #197

Closed
1 task done
pavithraes opened this issue Oct 23, 2022 · 3 comments · Fixed by #399
Closed
1 task done

[DOC] - Update end user conda-store tutorial with new UI #197

pavithraes opened this issue Oct 23, 2022 · 3 comments · Fixed by #399
Assignees
Labels

Comments

@pavithraes
Copy link
Member

pavithraes commented Oct 23, 2022

Preliminary Checks

Summary

Docs page to update: https://www.nebari.dev/tutorials/creating-new-environments

New UI: https://github.com/Quansight/conda-store-ui

Review and update the content+images!

@pavithraes
Copy link
Member Author

Just to cross-link, this is the PR that adds the new conda-store UI to Nebari: nebari-dev/nebari#1564

@kcpevey
Copy link
Contributor

kcpevey commented Jan 3, 2023

Need to add conda-store instructions to this FAQ question. And a link to conda-store tutorial which I imagine is a separate part of this issue.

@pavithraes
Copy link
Member Author

From #262:

Summary
The tutorial needs changes in a few places to fix incorrect statements and screenshots. The problems are not severe, but a new user might be frustrated.

nebari.dev/docs/tutorials/creating-new-environments

Steps to Resolve this Issue

  1. In conda-store, the default page after logging in is not the user page but the environments page. Add a description for the environments page before the user page.
  2. I don't see a "Create New Environment" button, so that's either because I already have environments or the button has been removed and the user needs to be pointed to the "+" button on the environments page.
  3. Move the note to add ipykernel and ipywidgets up to the sample environment specification in step 2.1 where a user will normally include those packages.
  4. Update the screenshot of the completed example environment. It's missing ipywidgets.
  5. I always have to refresh my browser to see if the build is complete, so add something about refreshing the browser to this: "The page will automatically update when the build is complete."
  6. Let's make this more positive: "To install new packages through either conda or pip you'll need to navigate back to the Edit page of your environment in the conda-store web interface." by changing to something like "To install new packages through either conda or pip simply navigate back to the Edit page of your environment in the conda-store web interface, modify the dependencies, and click submit."
  7. Tell the user how to get to the full logs: "Navigate to the Full Logs (click the build number and scroll down to the full logs button) to investigate in more detail. Also, from the build status page you can trigger re-build ("refresh" button) in case you hit issues with intermittent outages, etc.
  8. "If you need to use Dask." should not be under troubleshooting unless an error or failure can be described. Alternatively, it could be made into a note near the sample environment specification in step 2.1.

@pavithraes pavithraes removed this from the 🪴 Nebari rename milestone May 30, 2023
@pavithraes pavithraes moved this from New 🚦 to TODO 📬 in 🪴 Nebari Project Management Jan 9, 2024
@pavithraes pavithraes added this to the 2024.1.1 milestone Jan 9, 2024
@pavithraes pavithraes mentioned this issue Jan 15, 2024
18 tasks
@pavithraes pavithraes moved this from TODO 📬 to In review/QA 👀 in 🪴 Nebari Project Management Jan 16, 2024
@github-project-automation github-project-automation bot moved this from Todo 📬 to Done 💪🏾 in 📖 - Documentation May 7, 2024
@github-project-automation github-project-automation bot moved this from In review/QA 👀 to Done 💪🏾 in 🪴 Nebari Project Management May 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: Done 💪🏾
Development

Successfully merging a pull request may close this issue.

3 participants