Add installation guide to README and restructure contributing documentation#189
Conversation
Co-authored-by: JesseStutler <38534065+JesseStutler@users.noreply.github.com>
Co-authored-by: JesseStutler <38534065+JesseStutler@users.noreply.github.com>
CONTRIBUTING.md
Outdated
| - [`node.js`](https://nodejs.org/en/download) installed on your system | ||
| - A running Kubernetes cluster with [Volcano](https://github.com/volcano-sh/volcano#quick-start-guide) installed | ||
| - Volcano dashboard deployed (see [Installation Guide](README.md#installation) in the main README) | ||
| - Recommended IDE: [`Visual Studio Code`](https://code.visualstudio.com/download) |
| ```bash | ||
| kubectl port-forward svc/volcano-dashboard 8080:80 -n volcano-system --address 0.0.0.0 | ||
| ``` | ||
| ### Work on an Issue |
There was a problem hiding this comment.
@copilot Also can add file an issue part just like in https://github.com/volcano-sh/volcano/blob/master/contribute.md#file-an-issue
There was a problem hiding this comment.
Added "File an Issue" section similar to volcano's contribute.md. (deb2d29)
CONTRIBUTING.md
Outdated
| ## Contributor Workflow | ||
|
|
||
| ### Development | ||
| ### Setting Up Development Environment |
CONTRIBUTING.md
Outdated
| ## Submitting Pull Requests | ||
|
|
||
| We are assuming that you have made the changes in the code by following above guidelines. | ||
| ### Creating Pull Requests |
There was a problem hiding this comment.
@copilot I think we don't need to refactor the ###Creating Pull Requests part except the 4. Create a pull request
There was a problem hiding this comment.
Reverted the "Creating Pull Requests" section to original formatting, keeping only the new item 4. (deb2d29)
…ction, revert formatting changes Co-authored-by: JesseStutler <38534065+JesseStutler@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
This pull request adds a comprehensive installation guide to the README and restructures the CONTRIBUTING.md file to better separate user installation from contributor workflow documentation, making the project more accessible to both users and contributors.
Key changes:
- Added a dedicated "Installation" section to README.md with clear prerequisites and step-by-step instructions
- Restructured CONTRIBUTING.md to focus on contributor workflow with sections like "Before You Get Started", "Your First Contribution", and "File an Issue"
- Cross-referenced installation instructions between README.md and CONTRIBUTING.md
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| README.md | Added comprehensive installation section with prerequisites, deployment steps, and access instructions for both local and remote scenarios |
| CONTRIBUTING.md | Restructured to separate contributor prerequisites from general installation, added "File an Issue" section, and improved PR submission guidelines |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| To contribute to the volcano dashboard project, you need: | ||
|
|
||
| ### Install volcano dashboard | ||
| - [`node.js`](https://nodejs.org/en/download) installed on your system |
There was a problem hiding this comment.
The official name of the JavaScript runtime is "Node.js" (with capital N), not "node.js". This should be corrected for proper naming convention.
| - [`node.js`](https://nodejs.org/en/download) installed on your system | |
| - [`Node.js`](https://nodejs.org/en/download) installed on your system |
| 3. Access the dashboard by port-forwarding the service: | ||
|
|
||
| ```bash | ||
| kubectl port-forward svc/volcano-dashboard 8080:80 -n volcano-system --address 0.0.0.0 |
There was a problem hiding this comment.
The kubectl port-forward example binds the dashboard service to 0.0.0.0, which exposes it on all network interfaces and, together with the remote access instructions below, can make the dashboard reachable to anyone who can reach that host and port. If the dashboard is not protected by strong authentication/authorization, this can lead to unauthorized access to cluster information or actions. Consider binding the port-forward to localhost only and requiring a secure channel (e.g., SSH tunnel or VPN) for remote access instead of exposing it on all interfaces.
|
/approve |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: JesseStutler The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
Original prompt
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.