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.

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

Jump to bottom

Update conda-store docs #399

Merged
merged 13 commits into from
May 7, 2024
Merged

Update conda-store docs #399

merged 13 commits into from
May 7, 2024

Conversation

pavithraes
Copy link
Member

@pavithraes pavithraes commented Jan 15, 2024 •
edited
Loading

Reference Issues or PRs

Closes #197

What does this implement/fix?

Put a x in the boxes that apply

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds a feature)
  • Breaking change (fix or feature that would cause existing features not to work as expected)
  • Documentation Update
  • Code style update (formatting, renaming)
  • Refactoring (no functional changes, no API changes)
  • Build related changes
  • Other (please describe):

Testing

  • Did you test the pull request locally?
  • Did you add new tests?

Documentation

Access-centered content checklist

Text styling

  • The content is written with plain language (where relevant).
  • If there are headers, they use the proper header tags (with only one level-one header: H1 or # in markdown).
  • All links describe where they link to (for example, check the Nebari website).
  • This content adheres to the Nebari style guides.

Non-text content

  • All content is represented as text (for example, images need alt text, and videos need captions or descriptive transcripts).
  • If there are emojis, there are not more than three in a row.
  • Don't use flashing GIFs or videos.
  • If the content were to be read as plain text, it still makes sense, and no information is missing.

Any other comments?

With the updates, this page may not belong in "tutorials".

Should be merged after #397 and conda-incubator/conda-store#726

@netlify Netlify
Copy link

netlify bot commented Jan 15, 2024 •
edited
Loading

✅ Deploy Preview for nebari-docs ready!

Name Link
🔨 Latest commit 4a376e4
🔍 Latest deploy log https://app.netlify.com/sites/nebari-docs/deploys/663a67b8b8f4c600088a61ce
😎 Deploy Preview https://deploy-preview-399--nebari-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@pavithraes pavithraes added type: maintenance 🛠 Day-to-day maintenance tasks status: in progress 🏗 This task is currently being worked on labels Jan 15, 2024
@pavithraes pavithraes added needs: review 👀 This PR is complete and ready for reviewing and removed status: in progress 🏗 This task is currently being worked on labels Jan 15, 2024
@pavithraes pavithraes marked this pull request as ready for review January 15, 2024 17:49
@pavithraes pavithraes requested a review from kcpevey January 15, 2024 17:52
@pavithraes pavithraes added the status: blocked ⛔️ This item is on hold due to another task label Jan 16, 2024
@pavithraes pavithraes self-assigned this Jan 16, 2024
@pavithraes pavithraes added this to the 2024.1.1 milestone Jan 16, 2024
@pavithraes
Copy link
Member Author

Note from community meeting - Add additional note about installing packages with pip outside a virtual env.

xref: nebari-dev/nebari#2191

@pavithraes pavithraes added status: in progress 🏗 This task is currently being worked on needs: changes 🧱 Review completed - some changes are needed before merging and removed needs: review 👀 This PR is complete and ready for reviewing status: in progress 🏗 This task is currently being worked on labels Feb 7, 2024
kcpevey
kcpevey reviewed Feb 16, 2024
View reviewed changes
Copy link
Contributor

@kcpevey kcpevey left a comment

Choose a reason for hiding this comment

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

Just had a few things to expand on, but otherwise looks good!

docs/docs/tutorials/creating-new-environments.md Outdated Show resolved Hide resolved
docs/docs/tutorials/creating-new-environments.md Outdated Show resolved Hide resolved
docs/docs/tutorials/creating-new-environments.md Outdated

![conda-store UI - Sample environment build details page: showing the conda environment artifacts](/img/tutorials/conda_store_build_details_bottom.png)
* `analyst` namespace - Users in the `analyst` group can view and `admin` group can view+edit the environments in this namespace
* `developer` namespace - Users in the `developer` and `admin` groups can view+edit the environments in this namespace
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm pretty sure developer is required for access to the dask workers.

Copy link
Contributor

Choose a reason for hiding this comment

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

I was about to suggest some changes, but noticed this will be confusing with the keycloak roles and the concepts of namespaces intertwined, so I will think about how to rewrite this a bit

docs/docs/tutorials/creating-new-environments.md Outdated

Please keep in mind that these are _NOT_ available to Dask workers!
:::
Include the [`nebari-dask` metapackage](https://anaconda.org/conda-forge/nebari-dask) in your environment to use Dask. This ensures you have the correct version of `dask-gateway` and the latest versions of `dask` and `distributed` libraries.
Copy link
Contributor

Choose a reason for hiding this comment

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

Add note that the nebari-dask metapackage version should match nebari version

Copy link
Contributor

Choose a reason for hiding this comment

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

also note again here that you have to be in the develop group to be able to access dask.

docs/docs/tutorials/creating-new-environments.md Outdated

Navigate to the `Full Logs` to investigate in more detail. Also, from the build status page you can trigger re-build in
case you hit issues with intermittent outages, etc.
Include the `jhub-apps` package in your environment to create apps using the JHub App Launcher. You will also need the relevant app development framework and other necessary packages in the environment.
Copy link
Contributor

Choose a reason for hiding this comment

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

You don't need jhub-apps itself. You need jhsingle-native-proxy>=0.8.2 for all apps.

For panel apps you'll also need bokeh-root-cmd>=0.1.2 in additional to the panel deps.

Copy link
Contributor

Choose a reason for hiding this comment

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

The app launcher now has its own docs which explain the environment requirements. I think its safe to remove this here.

@viniciusdc
Copy link
Contributor

I will do a last passtrough here in will merge, thanks @pavithraes @kcpevey

@kcpevey kcpevey mentioned this pull request Apr 29, 2024
Closed
viniciusdc
viniciusdc approved these changes Apr 29, 2024
View reviewed changes
Copy link
Contributor

@viniciusdc viniciusdc left a comment

Choose a reason for hiding this comment

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

LGTM

@viniciusdc
Copy link
Contributor

I will fix the conflicts and merge this, as we need to at least remove the old docs on this matter. I will open a follow-up issue about what needs to be addressed.

@viniciusdc viniciusdc merged commit 8ba8a5a into nebari-dev:main May 7, 2024
6 checks passed
@kcpevey kcpevey mentioned this pull request May 7, 2024
Open
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kcpevey kcpevey kcpevey left review comments

@viniciusdc viniciusdc viniciusdc approved these changes

Assignees

@pavithraes pavithraes

Labels
needs: changes 🧱 Review completed - some changes are needed before merging status: blocked ⛔️ This item is on hold due to another task type: maintenance 🛠 Day-to-day maintenance tasks
Projects
📖 - Documentation
Status: Done 💪🏾
🪴 Nebari Project Management
Status: Done 💪🏾
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[DOC] - Update end user conda-store tutorial with new UI
3 participants
@pavithraes @viniciusdc @kcpevey