-
Notifications
You must be signed in to change notification settings - Fork 104
docs: professionalize site messaging and add project governance #480
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
Open
yoursanonymous
wants to merge
1
commit into
volcano-sh:master
Choose a base branch
from
yoursanonymous:pr-suggestions-analysis
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| # Contributing to the Volcano Website | ||
|
|
||
| Thank you for your interest in contributing to the Volcano website! This guide will help you get started with contributing documentation, blog posts, and site improvements. | ||
|
|
||
| ## Code of Conduct | ||
|
|
||
| All contributors are expected to follow the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/main/code-of-conduct.md). | ||
|
|
||
| ## Getting Started | ||
|
|
||
| ### 1. Prerequisite: Install Hugo | ||
|
|
||
| This website is built with [Hugo](https://gohugo.io/). You must install the **Extended** version of Hugo to build the site locally. | ||
|
|
||
| - **Check Version**: Refer to `HUGO_VERSION` in [netlify.toml](./netlify.toml) for the recommended version (currently `0.57.2`). | ||
| - **Installation**: See the [Hugo Installation Guide](https://gohugo.io/getting-started/installing/). | ||
|
|
||
| ### 2. Fork and Clone | ||
|
|
||
| 1. Fork this repository on GitHub. | ||
| 2. Clone your fork locally: | ||
| ```bash | ||
| git clone https://github.com/YOUR_USERNAME/website.git | ||
| cd website | ||
| ``` | ||
|
|
||
| ### 3. Local Development | ||
|
|
||
| To run a local server and preview your changes: | ||
| ```bash | ||
| hugo server -D | ||
| ``` | ||
| The site will be available at `http://localhost:1313/`. | ||
|
|
||
| ## PR Workflow | ||
|
|
||
| 1. **Create a branch**: `git checkout -b your-feature-branch` | ||
| 2. **Make changes**: Keep your changes focused and concise. | ||
| 3. **Commit**: Use descriptive commit messages. | ||
| 4. **Push & PR**: Push your branch to your fork and open a Pull Request against the `master` branch. | ||
| 5. **Netlify Preview**: Each PR will generate a unique preview URL. Check the "Checks" section of your PR for the "deploy/netlify" link. | ||
|
|
||
| ## Documentation Standards | ||
|
|
||
| - Use standard Markdown (`.md`). | ||
| - Ensure all links use `https://` where possible. | ||
| - For large images, optimize for web to keep load times fast. | ||
|
|
||
| For more details on the general Volcano contribution process, see the [main Volcano contribution guide](https://github.com/volcano-sh/volcano/blob/master/contribute.md). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| # Security Policy | ||
|
|
||
| ## Supported Versions | ||
|
|
||
| The following versions of Volcano are currently supported with security updates: | ||
|
|
||
| | Version | Supported | | ||
| | ------- | ------------------ | | ||
| | v1.11.x | :white_check_mark: | | ||
| | v1.10.x | :white_check_mark: | | ||
| | < v1.10 | :x: | | ||
|
|
||
| ## Reporting a Vulnerability | ||
|
|
||
| We take the security of the Volcano project seriously. If you believe you have found a security vulnerability, please report it to us as soon as possible. | ||
|
|
||
| **Do not open a public GitHub issue for security vulnerabilities.** | ||
|
|
||
| ### Reporting Process | ||
|
|
||
| 1. **Email us**: Send a detailed report to [volcano-security@googlegroups.com](mailto:volcano-security@googlegroups.com). | ||
| 2. **CNCF Process**: As a CNCF project, you can also follow the [CNCF security policy](https://github.com/cncf/foundation/blob/main/security-policy.md). | ||
|
|
||
| ### What to Include | ||
| Please provide as much information as possible, including: | ||
| - A description of the vulnerability. | ||
| - Steps to reproduce the issue. | ||
| - Potential impact. | ||
| - Any suggested fixes or mitigations. | ||
|
|
||
| ## Disclosure Process | ||
|
|
||
| We follow a responsible disclosure process. Once a report is received: | ||
| 1. We will acknowledge receipt of your report within 48 hours. | ||
| 2. We will investigate the issue and provide a timeline for a fix. | ||
| 3. Once a fix is available, we will coordinate a public disclosure. | ||
|
|
||
| Thank you for helping keep Volcano secure! | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
The table of supported versions is a great start. To avoid it becoming outdated and to provide clarity for future releases, consider stating the project's version support policy explicitly. For example, you could mention how many recent minor versions are supported (e.g., 'The two most recent minor versions receive security updates.'). This would make the policy clearer for users and contributors as new versions of Volcano are released.