Install Docs Update

[kenafoster]

Reference Issues or PRs

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)
• [ X ] Documentation Update
• [ ] Code style update (formatting, renaming)
• [ ] Refactoring (no functional changes, no API changes)
• [ ] Build related changes
• [ ] Other (please describe):

This PR intends to update the quick start and installation guides with the following clarifications:

• Clarify the distinction between installing the Nebari package and deploying a Nebari system (e.g. the Nebari package is the "Nebari deployer" and is used to stand up Nebari deployments on local or remote systems).
• Clarify that the version of the "Nebari deployer" package (e.g. pip install nebari==1.2.3) must match the version of Nebari specified in nebari-config.yaml
• Clarify that all Nebari extensions installed in the environment used to deploy Nebari will themselves be deployed along with Nebari, and that this is the mechanism used to specify and deploy Nebari extensions
• Clarify that there is no mechanism to prevent deployment of locally-installed Nebari extensions, nor is there any mechanism to un-install an extension from a deployment.
• Add "Best Practices" for creating a known Python environment used for deployment. Add example steps to use conda for this purpose
• Move the "Validate (optional)" and "Render (optional)" sections to before the "Deploy" section
• Summarize the purpose of the /stage/ directory, when it can be deleted, and why deleting it can resolve certain deployment errors.

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?

[netlify[bot]]

✅ Deploy Preview for nebari-docs ready!

Name	Link
🔨 Latest commit	c15a812ee1aae8fc2bb8923ad4b094c09e9ab8aa
🔍 Latest deploy log	https://app.netlify.com/sites/nebari-docs/deploys/66916676abb4c70008e2af55
😎 Deploy Preview	https://deploy-preview-473--nebari-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

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

[kenafoster]

Hi @kenafoster this looks awesome, thanks for going over and submitting these 🚀 I've made some suggestions here and there, let me know your thoughts.

Thank you! I've addressed most of them. One of the comments I need to give more thought (and will send one more commit), and I'm not sure about the nebari0 conda env you mentioned.

[viniciusdc]

Hi @kenafoster this looks awesome. Thanks for going over and submitting these 🚀 I've made some suggestions here and there; let me know your thoughts.

Thank you! I've addressed most of them. One of the comments I need to give more thought to (and will send one more commit), and I'm not sure about the nebari0 conda env you mentioned.

Excellent, thanks, @kenafoster. I will have another look today. Do not worry too much about that; it only showcases an example of utilization.

[kenafoster]

@viniciusdc thanks, ready for re-review. Do you want to 'resolve conversation' on the comment chains where you're satisfied that I addressed your feedback? (Unless it is 100% good to merge now, in which case doesn't matter). Getting hard to track which to-dos are still open