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 "Creating new environment on Nebari" tutorial #262

Closed
1 task done
ericdatakelly opened this issue Jan 28, 2023 · 1 comment
Closed
1 task done

[DOC] - Update "Creating new environment on Nebari" tutorial #262

ericdatakelly opened this issue Jan 28, 2023 · 1 comment
Labels
area: documentation 📖 type: duplicate 👯 This issue or pull request already exists

Comments

@ericdatakelly
Copy link
Contributor

Preliminary Checks

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.

https://www.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
Copy link
Member

@ericdatakelly Thanks for opening this, and the detailed list of steps!

This is a duplicate of #197, so I'll move your notes to that issue and close this one. We can continue discussions there :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: documentation 📖 type: duplicate 👯 This issue or pull request already exists
Projects
None yet
Development

No branches or pull requests

2 participants