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

Docs: explain cluster states #2834

Merged
merged 2 commits into from
Dec 4, 2023
Merged

Conversation

asaiacai
Copy link
Contributor

@asaiacai asaiacai commented Dec 2, 2023

Closes #2663

@concretevitamin
Copy link
Collaborator

Thanks @asaiacai! What do you think about adding a quick sentence that refers to https://skypilot.readthedocs.io/en/latest/reference/cli.html#sky-status? E.g., "See here for a list of all possible cluster states." Reasons:

  • Most new users may not need a detailed explanation right at quickstart
  • Explaining erroneous states may be too complex at quickstart

@asaiacai
Copy link
Contributor Author

asaiacai commented Dec 3, 2023

@concretevitamin, thanks for the fast reply! Yeah that makes sense. I changed it to just be a cross ref the the sky status section of the CLI docs.

It looks like currently sphinx-click doesn't have a nice way to cross ref click commands/programs according to:

so I created explicit targets for each of the CLI commands, which probably isn't the most elegant solution, so let me know if you want to change it. It looks like people have been asking for cross referencing commands in sphinx-click but there's been no change for over 6 years...

Copy link
Collaborator

@concretevitamin concretevitamin left a comment

Choose a reason for hiding this comment

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

Thanks for investigating the cross-ref issues in sphinx! LGTM with a small nit.

docs/source/getting-started/quickstart.rst Outdated Show resolved Hide resolved
Co-authored-by: Zongheng Yang <zongheng.y@gmail.com>
@concretevitamin
Copy link
Collaborator

Thanks @asaiacai!

@concretevitamin concretevitamin merged commit 04553ad into skypilot-org:master Dec 4, 2023
19 checks passed
@asaiacai asaiacai deleted the docs branch December 5, 2023 18:05
remyleone pushed a commit to remyleone/skypilot that referenced this pull request Dec 26, 2023
* cross ref cluster states in quickstart

* fix formatting

Co-authored-by: Zongheng Yang <zongheng.y@gmail.com>

---------

Co-authored-by: Zongheng Yang <zongheng.y@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Docs] Explain the concept of INIT or UP for clusters
2 participants