updated DEVELOPMENT.md to reflect latest codebase changes and fix errors #229
Conversation
|
Welcome @zclyne! It looks like this is your first PR to karmada-io/dashboard 🎉 |
karmada-bot
added
the
size/S
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @zclyne, 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 enhancing the developer experience by updating the DEVELOPMENT.md documentation. It streamlines the local environment setup instructions and rectifies a critical error in the command used to start the backend API service, ensuring developers can get up and running more smoothly.
Highlights
- Documentation Update: The
DEVELOPMENT.mdfile has been significantly updated to reflect the current state of the codebase and improve the developer onboarding experience. - Streamlined Environment Setup: Outdated instructions for loading images have been removed, and the guide now directs users to set up a Karmada environment using the
local-up-karmada.shscript from the main Karmada repository, making the setup process clearer and more aligned with current practices. - API Service Startup Fix: An error in the shell command to start the backend
apiservice has been corrected by removing the--skip-karmada-apiserver-tls-verifyflag, ensuring the service starts correctly.
Using Gemini Code Assist
The 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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
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 .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and 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 to provide feedback.
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
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
| --kubeconfig=${path/to/karmada.config} \ | ||
| --context=karmada-host \ | ||
| --insecure-port=8000 | ||
| ``` | ||
|
|
There was a problem hiding this comment.
These newlines were added by my formatter and I believe it is good to keep them
Signed-off-by: Yifan <[email protected]>
zclyne
force-pushed
the
enhance-development-md
branch
from
3697729 to
9dd6abd
Compare
DEVELOPMENT.md
Outdated
| _output/bin/${os name}/${os arch}/karmada-dashboard-api \ | ||
| --karmada-kubeconfig=${path/to/karmada.config} \ | ||
| --karmada-context=karmada-apiserver \ | ||
| --skip-karmada-apiserver-tls-verify \ | ||
| --kubeconfig=${path/to/karmada.config} \ | ||
| --context=karmada-host \ | ||
| --insecure-port=8000 |
There was a problem hiding this comment.
The placeholders ${os name}/${os arch} and ${path/to/karmada.config} are not valid variable names and could be confusing. Using <your-os>/<your-arch> and $HOME/.kube/karmada.config would be clearer.
| _output/bin/${os name}/${os arch}/karmada-dashboard-api \ | |
| --karmada-kubeconfig=${path/to/karmada.config} \ | |
| --karmada-context=karmada-apiserver \ | |
| --skip-karmada-apiserver-tls-verify \ | |
| --kubeconfig=${path/to/karmada.config} \ | |
| --context=karmada-host \ | |
| --insecure-port=8000 | |
| _output/bin/<your-os>/<your-arch>/karmada-dashboard-api \ | |
| --karmada-kubeconfig=$HOME/.kube/karmada.config \ | |
| --karmada-context=karmada-apiserver \ | |
| --kubeconfig=$HOME/.kube/karmada.config \ | |
| --context=karmada-host \ | |
| --insecure-port=8000 |
|
/assign |
| --kubeconfig=${path/to/karmada.config} \ | ||
| --context=karmada-host \ | ||
| --insecure-port=8000 | ||
| ``` | ||
|
|
Signed-off-by: Yifan <[email protected]>
karmada-bot
added
size/M
|
/lgtm |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: warjiang The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
karmada-bot
added
the
approved
What type of PR is this?
/kind documentation
What this PR does / why we need it: This PR updates
DEVELOPMENT.mdto make it up-to-date with the status of the code base and fixes an error in the shell command to start the backendapiservice.Which issue(s) this PR fixes:
Fixes #228
Special notes for your reviewer: None.
Does this PR introduce a user-facing change?: No.