Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,7 @@ resources*
public
.vscode/*
.DS_Store
.hugo_build.lock
.hugo_build.lock

#Ignore vscode AI rules
.github/instructions/codacy.instructions.md
49 changes: 49 additions & 0 deletions CONTRIBUTING.md
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).
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ hosted at https://volcano.sh.
We use [Hugo](https://gohugo.io/) to format and generate our website, and
[Netlify](https://www.netlify.com/) to manage the deployment of the site. Hugo
is an open-source static site generator that provides us with templates, content
organisation in a standard directory structure, and a website generation engine.
organization in a standard directory structure, and a website generation engine.
You write the pages in Markdown, and Hugo wraps them up into a website.

* Please see [How to contribute](https://github.com/volcano-sh/volcano/blob/master/contribute.md) for instructions on how to contribute, if you are not familiar with the
Expand Down
38 changes: 38 additions & 0 deletions SECURITY.md
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: |
Comment on lines +7 to +11

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

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.


## 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!
19 changes: 8 additions & 11 deletions config/_default/params.toml
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ day_night = false
font = "default"

# Description for social sharing and search engines. If undefined, superuser role is used in place.
description = "Volcano is a batch container computing engine for Kubernetes."

# Default image for social sharing and search engines. Place image in `static/img/` folder and specify image name here.

Expand Down Expand Up @@ -48,26 +49,22 @@ time_format = "3:04 PM"
############################

# Enter contact details (optional). To hide a field, clear it to "".
email = "test@example.org"
phone = "888 888 88 88"
address = "Building 1 Room 1, Stanford University, California, 90210, USA"
email = "volcano-sh@googlegroups.com"
phone = ""
address = ""

# Office hours: use `<br>` to insert a line break, or set to "" to remove office hours
office_hours = """Monday 10:00 to 13:00<br>
Wednesday 09:00 to 10:00<br>
Otherwise email to book an appointment"""
office_hours = ""

# Enter an optional link for booking appointments (e.g. calendly.com).
appointment_url = ""

# Contact links
# Set to `[]` to disable, or comment out unwanted lines with a hash `#`.
contact_links = [
{icon = "twitter", icon_pack = "fab", name = "DM Me", link = "https://twitter.com/Twitter"},
{icon = "skype", icon_pack = "fab", name = "Skype Me", link = "skype:echo123?call"},
{icon = "keybase", icon_pack = "fab", name = "Chat on Keybase", link = "https://keybase.io/"},
{icon = "comments", icon_pack = "fas", name = "Discuss on Forum", link = "https://discourse.gohugo.io"},
# {icon = "telegram", icon_pack = "fab", name = "Telegram Me", link = "https://telegram.me/@Telegram"},
{icon = "twitter", icon_pack = "fab", name = "Twitter", link = "https://twitter.com/Volcano"},
{icon = "github", icon_pack = "fab", name = "GitHub", link = "https://github.com/volcano-sh/volcano"},
{icon = "comments", icon_pack = "fas", name = "Mailing List", link = "https://groups.google.com/forum/#!forum/volcano-sh"},
]

# Display a map.
Expand Down
2 changes: 1 addition & 1 deletion content/en/home/hero.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ weight = 3
label = '<i class="fas fa-download"></i> Install Now'
+++

An open platform to enable Edge computing :rocket:
An open platform to enable Batch container computing :rocket:
<div style="margin-top: -0.5rem;">
<a id="academic-release" href="https://github.com/volcano-sh/volcano" data-repo="volcano-sh/volcano">
Latest release <!-- V -->
Expand Down
2 changes: 1 addition & 1 deletion doc/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ volcano
|-- nodeorder
|-- predicates
|-- priority
|-- prorortion
|-- proportion
|-- webhooks
|-- admission
|-- queue
Expand Down