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

Update links in documentation and README #366

Merged
merged 5 commits into from
Feb 18, 2022
Merged

Update links in documentation and README #366

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
dbd8b18
formatting and linking
gmittal Feb 18, 2022
b2597d4
Fix sky link
gmittal Feb 18, 2022
c0fbee1
Add doc status
gmittal Feb 18, 2022
8a789c1
remove it
gmittal Feb 18, 2022
d0c91fe
update readme
gmittal Feb 18, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/source/getting-started/installation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ Install Sky using pip:
.. code-block:: console

$ # Clone the sky codebase
$ git clone ssh://git@github.com/concretevitamin/sky-experiments.git
$ cd sky-experiments
$ git clone ssh://git@github.com/sky-proj/sky.git
$ cd sky
$ # Sky requires python >= 3.6.
$ pip install ".[all]"

Expand Down
6 changes: 3 additions & 3 deletions docs/source/reference/yaml-spec.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,12 @@ describe all fields available.

# Per-node resource requirements (optional).
resources:
cloud: aws # A cloud (optional) can be specified, if desired.
cloud: aws # A cloud (optional) can be specified, if desired.

# Accelerator requirements (optional) can be specified, use sky show-gpus
# to view available accelerator configurations.
accelerators:
V100: 4 # Specify the accelerator type and the count per node.
V100: 4 # Specify the accelerator type and the count per node.

# Accelerator arguments (optional) provides additional metadata for some
# accelerators, such as the TensorFlow version for TPUs.
Expand All @@ -51,7 +51,7 @@ describe all fields available.
/datasets-storage:
name: sky-dataset
source: ~/datasets
force_stores: [s3] # Could be [s3, gcs], [gcs] default: None
force_stores: [s3] # Could be [s3, gcs], [gcs] default: None
persistent: True # Defaults to True, can be set to false.

# This re-uses a predefined bucket (sky-dataset, defined above) and mounts it
Expand Down
14 changes: 7 additions & 7 deletions sky/setup_files/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Sky

![pytest](https://github.com/concretevitamin/sky-experiments/actions/workflows/pytest.yml/badge.svg)
![pytest](https://github.com/sky-proj/sky/actions/workflows/pytest.yml/badge.svg)

Sky is a tool to run any workload seamlessly across different cloud providers through a unified interface. No knowledge of cloud offerings is required or expected – you simply define the workload and its resource requirements, and Sky will automatically execute it on AWS, Google Cloud Platform or Microsoft Azure.

Expand Down Expand Up @@ -28,17 +28,17 @@ run: |
```

## Getting Started
<!-- TODO: fill the document link -->
Please refer to our [document]().
- [Getting Started]()
- [Sky CLI]()
Please refer to our [documentation](https://sky-proj-sky.readthedocs-hosted.com/en/latest/).
- [Installation](https://sky-proj-sky.readthedocs-hosted.com/en/latest/getting-started/installation.html)
- [Quickstart](https://sky-proj-sky.readthedocs-hosted.com/en/latest/getting-started/quickstart.html)
- [Sky CLI](https://sky-proj-sky.readthedocs-hosted.com/en/latest/reference/cli.html)

### Installation

```bash
# Clone the sky codebase
git clone ssh://git@github.com/concretevitamin/sky-experiments.git
cd sky-experiments
git clone ssh://git@github.com:sky-proj/sky.git
cd sky
# Sky requires python >= 3.6.
pip install ".[all]"
```
Expand Down