docs: improve installation guide with SkyPilot prerequisites #321
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This change ensures that GCP dependencies are installed by default when installing skyshift. Previously, users would encounter errors when trying to use GCP features without explicitly installing the GCP dependencies. Error fixed: Failed to import dependencies for GCP. Try: pip install "skypilot[gcp]"
- Add clear prerequisites section with SkyPilot installation instructions - Specify exact SkyPilot version requirements for each cloud provider - Add note about Apple Silicon requirements - Include different installation options (basic, server, dev) - Add Docker installation alternative - Link to official cloud setup guides - Update repository URL to sky-shift/skyshift - Add verification steps with sky check
- Remove Docker installation section as it's not yet available - Remove version pinning from skypilot installation commands
| For Macs, macOS >= 10.15 is required to install SkyShift. Apple Silicon-based devices (e.g. Apple M1) must run ``pip uninstall grpcio; conda install -c conda-forge grpcio=1.43.0`` prior to installing SkyShift. | ||
|
|
||
| To install SkyShift's python API and CLI, run: | ||
| Prerequisites |
Collaborator
There was a problem hiding this comment.
This is not true right?
Collaborator
There was a problem hiding this comment.
This should be in cloud section; the mvp for skyshift is over K8s.
Contributor
Author
There was a problem hiding this comment.
This is true, they need to run sky check at least once. But you are right, it should be merged to the cloud branch
Contributor
Author
There was a problem hiding this comment.
There is no cloud branch, must have been merged into the MVP
| Prerequisites | ||
| ------------ | ||
|
|
||
| SkyShift requires SkyPilot to be installed and configured with at least one cloud provider. Follow these steps to set up your environment: |
Collaborator
There was a problem hiding this comment.
It is not required if users only want to use onprem resources.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR improves the installation documentation by adding clear instructions about SkyPilot prerequisites and cloud provider setup.
Changes
sky checkTesting