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] Revamp docs for secrets and distributed jobs #3715

Merged
merged 26 commits into from
Jul 4, 2024
Merged

Conversation

Michaelvll
Copy link
Collaborator

@Michaelvll Michaelvll commented Jul 2, 2024

This PR includes the following:

  1. Make Environment Variables page level-1 as the secret management and environments are important to our users.
  2. Make distributed jobs level-1 for easier reference.
  3. Revamp docs to make it easier to follow.

Find the updated docs of this PR: https://skypilot.readthedocs.io/en/secrets-env-var/running-jobs/environment-variables.html

Tested (run the relevant ones):

  • Code formatting: bash format.sh
  • Any manual or new tests for this PR (please specify below)
  • All smoke tests: pytest tests/test_smoke.py
  • Relevant individual smoke tests: pytest tests/test_smoke.py::test_fill_in_the_name
  • Backward compatibility tests: conda deactivate; bash -i tests/backward_compatibility_tests.sh

Copy link
Member

@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 @Michaelvll. Some comments.

docs/source/docs/index.rst Outdated Show resolved Hide resolved
docs/source/getting-started/quickstart.rst Outdated Show resolved Hide resolved
docs/source/running-jobs/distributed-jobs.rst Outdated Show resolved Hide resolved
docs/source/running-jobs/distributed-jobs.rst Outdated Show resolved Hide resolved
docs/source/running-jobs/distributed-jobs.rst Outdated Show resolved Hide resolved
docs/source/running-jobs/environment-variables.rst Outdated Show resolved Hide resolved
docs/source/running-jobs/environment-variables.rst Outdated Show resolved Hide resolved
docs/source/running-jobs/environment-variables.rst Outdated Show resolved Hide resolved
docs/source/running-jobs/environment-variables.rst Outdated Show resolved Hide resolved
docs/source/running-jobs/environment-variables.rst Outdated Show resolved Hide resolved
Michaelvll and others added 21 commits July 3, 2024 17:58
Copy link
Member

@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.

LGTM

docs/source/running-jobs/environment-variables.rst Outdated Show resolved Hide resolved
@Michaelvll Michaelvll merged commit 8674520 into master Jul 4, 2024
20 checks passed
@Michaelvll Michaelvll deleted the secrets-env-var branch July 4, 2024 17:58
Michaelvll added a commit that referenced this pull request Aug 23, 2024
* Add docs for secrets and env var

* add

* revamp docs

* partially

* Update docs/source/running-jobs/distributed-jobs.rst

Co-authored-by: Zongheng Yang <[email protected]>

* Update docs/source/running-jobs/environment-variables.rst

Co-authored-by: Zongheng Yang <[email protected]>

* Update docs/source/running-jobs/distributed-jobs.rst

Co-authored-by: Zongheng Yang <[email protected]>

* revert multi-node instruction

* Update docs/source/running-jobs/environment-variables.rst

Co-authored-by: Zongheng Yang <[email protected]>

* Update docs/source/running-jobs/environment-variables.rst

Co-authored-by: Zongheng Yang <[email protected]>

* Update docs/source/running-jobs/environment-variables.rst

Co-authored-by: Zongheng Yang <[email protected]>

* Update docs/source/running-jobs/environment-variables.rst

Co-authored-by: Zongheng Yang <[email protected]>

* Update docs/source/running-jobs/environment-variables.rst

Co-authored-by: Zongheng Yang <[email protected]>

* Update docs/source/running-jobs/environment-variables.rst

Co-authored-by: Zongheng Yang <[email protected]>

* Update docs/source/getting-started/quickstart.rst

Co-authored-by: Zongheng Yang <[email protected]>

* address

* Rephrase

* Update docs/source/running-jobs/environment-variables.rst

Co-authored-by: Zongheng Yang <[email protected]>

* fix

* move

* Update docs/source/running-jobs/environment-variables.rst

Co-authored-by: Zongheng Yang <[email protected]>

---------

Co-authored-by: Zongheng Yang <[email protected]>
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.

2 participants