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

Add docs around installing packages via pip #484

Merged
merged 13 commits into from
Sep 4, 2024

Conversation

kcpevey
Copy link
Contributor

@kcpevey kcpevey commented Jul 15, 2024

Reference Issues or PRs

Resolves #411

What does this implement/fix?

This adds docs for installing private packages on Nebari. As I was writing, I realized that I also answer a lot of questions around installing pip packages in general so I've added those as well.

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?

@kcpevey kcpevey requested a review from pavithraes July 15, 2024 20:40
Copy link

netlify bot commented Jul 15, 2024

Deploy Preview for nebari-docs ready!

Name Link
🔨 Latest commit 90f8546
🔍 Latest deploy log https://app.netlify.com/sites/nebari-docs/deploys/66d881ee63f74b000862b79a
😎 Deploy Preview https://deploy-preview-484--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.

@kcpevey kcpevey added the needs: review 👀 This PR is complete and ready for reviewing label Aug 6, 2024
@Adam-D-Lewis Adam-D-Lewis self-requested a review August 6, 2024 14:28
docs/docs/faq.md Outdated Show resolved Hide resolved
docs/docs/faq.md Outdated Show resolved Hide resolved
@Adam-D-Lewis
Copy link
Member

Adam-D-Lewis commented Aug 6, 2024

@kcpevey It's awesome to see this guide for users!

@kcpevey
Copy link
Contributor Author

kcpevey commented Aug 16, 2024

@Adam-D-Lewis can you give a formal review?

@Adam-D-Lewis Adam-D-Lewis self-requested a review August 21, 2024 23:41
docs/docs/faq.md Outdated Show resolved Hide resolved
@Adam-D-Lewis
Copy link
Member

A few minor comments, but approved. Thanks for the great write up!

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.

@kcpevey Left some small suggestions

docs/docs/how-tos/develop-local-packages.md Outdated Show resolved Hide resolved
docs/docs/how-tos/develop-local-packages.md Outdated Show resolved Hide resolved
Co-authored-by: Vinicius D. Cerutti <[email protected]>
docs/docs/faq.md Outdated Show resolved Hide resolved
@kcpevey
Copy link
Contributor Author

kcpevey commented Sep 4, 2024

All requested changes have been applied!

@kcpevey kcpevey merged commit 86efd77 into main Sep 4, 2024
6 checks passed
@kcpevey kcpevey deleted the package_develop_instructions branch September 4, 2024 20:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs: review 👀 This PR is complete and ready for reviewing
Projects
Status: Done 💪🏾
Development

Successfully merging this pull request may close these issues.

[ENH] - Improve experience of developing packages on Nebari
3 participants