docs: audit scheduler and job plugins and add documentation index

Open
  • Is something wrong?
#600 1 comment 0 reactions 1 assignee View on GitHub

Maintainers usually reply within 1 day

@SoumaCloud is already working on this.

Since Nov 5, 2026.

Assessment

This issue has not been assessed yet.

Description

Part of:https://github.com/volcano-sh/website/issues/595

Description

Audit the existing Volcano scheduler and job-plugin documentation to identify missing, outdated, or incomplete documentation.

The goal is to provide a comprehensive plugin documentation index covering the available scheduler and job plugins, their configuration names, purposes, supported versions, and corresponding documentation pages.

The audit should be based on the actual source code, plugin registrations, and existing documentation rather than relying solely on the current documentation or generated plugin lists.

Scope of Work

  • Source code audit: Inspect scheduler and job-plugin registrations and implementations to identify available plugins.
  • Documentation coverage: Compare the registered plugins and their implementations against the existing documentation.
  • Identify gaps: Find missing plugin guides, outdated configuration references, incorrect descriptions, and undocumented configuration options.
  • Plugin index: Add a centralized index table containing:
    • Plugin name/configuration name.
    • Plugin type (scheduler or job plugin).
    • Purpose and functionality.
    • Verified version availability.
    • Link to the corresponding documentation guide.
  • Update existing guides: Update outdated documentation and add missing plugin guides based on the audit findings.
  • Version compatibility: Update the Latest documentation by default. Verify historical release source tags before documenting plugin availability or behaviour in older versions.

Validation Requirements

  • Verify plugin registrations and configuration options against the actual source code.
  • Include source references for documented plugin behaviour.
  • Verify plugin availability against the relevant Volcano versions.
  • Deploy and test the plugins being documented.
  • Provide tested configuration examples, commands, environment details, and observed behaviour.
  • Ensure that documentation accurately reflects the implementation and does not describe unsupported functionality.

Expected Outcome

A comprehensive and maintainable plugin documentation index that allows users to discover available Volcano scheduler and job plugins, understand their functionality, identify version compatibility, and navigate to verified configuration guides.

Parent Issue

Umbrella issue: https://github.com/volcano-sh/website/issues/595

Dominant language
JavaScript
Stars
33
Forks
137
Avg merge
3d 23h
Merged PRs (30d)
4

Getting set up

  • No Dockerfile or Docker Compose file
  • Has a pull request template
  • No contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from volcano-sh/website

All issues in volcano-sh/website

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.