Skip to content

Enhance the enhancement issue template to include a check for website documentation updates #4724

@JesseStutler

Description

@JesseStutler

What is the problem you're trying to solve

The current enhancement template doesn't explicitly require that if a feature involves updates to design or user documentation, these documents must be synchronized with the official Volcano website. This can lead to outdated or incomplete documentation.

Describe the solution you'd like

I suggest adding a self-checklist item to the enhancement issue template. This item would state that if the feature requires documentation changes, the relevant documents must be updated and published to the Volcano official website (https://volcano.sh) as part of the feature's acceptance criteria. The repository for the website is volcano-sh/website.

Additional context

This change will standardize the feature development process, ensuring that documentation keeps pace with new features and improving the overall quality and usability of the project.

Metadata

Metadata

Assignees

Labels

kind/documentationCategorizes issue or PR as related to documentation.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions