-
Notifications
You must be signed in to change notification settings - Fork 881
[Docs] Fix SkyPilot config path #8374
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
base: master
Are you sure you want to change the base?
Conversation
Summary of ChangesHello @Michaelvll, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request focuses on improving the clarity and consistency of SkyPilot's documentation regarding configuration. It updates references to configuration paths, ensuring users are aware of both local and remote configuration options, and enhances internal linking for better documentation navigation. Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request improves the documentation by clarifying the different ways to configure SkyPilot. The change in config.rst adds information about remote configuration through the API server dashboard, and the change in kubernetes-getting-started.rst replaces a hardcoded file path with a more general reference to the configuration documentation. The changes are good, but I've pointed out a minor inconsistency in config.rst that could be addressed to make the documentation even clearer.
docs/source/reference/config.rst
Outdated
| ====================== | ||
|
|
||
| You can pass **optional configuration** to SkyPilot in the ``~/.sky/config.yaml`` file. | ||
| You can pass **optional configuration** to SkyPilot in the ``~/.sky/config.yaml`` file (local config) or on your SkyPilot API server dashboard (remote config) at http://<api-server-url>/dashboard/config. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a great addition to clarify that configuration can be done remotely via the API server dashboard. For consistency, you might also want to update the 'Configuration sources and overrides' section below. For example, line 11 still only mentions ~/.sky/config.yaml as the source for global configuration and could be updated to include the remote configuration option.
Tested (run the relevant ones):
bash format.sh/smoke-test(CI) orpytest tests/test_smoke.py(local)/smoke-test -k test_name(CI) orpytest tests/test_smoke.py::test_name(local)/quicktest-core(CI) orpytest tests/smoke_tests/test_backward_compat.py(local)