Skip to content

docs: add Headlamp plugin guide#504

Open
mahmoudmagdy1-1 wants to merge 1 commit into
volcano-sh:masterfrom
mahmoudmagdy1-1:docs-headlamp
Open

docs: add Headlamp plugin guide#504
mahmoudmagdy1-1 wants to merge 1 commit into
volcano-sh:masterfrom
mahmoudmagdy1-1:docs-headlamp

Conversation

@mahmoudmagdy1-1
Copy link
Copy Markdown

Please check if the PR fulfills these requirements

  • The commit message follows our guidelines

What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)
/kind documentation

What this PR does / why we need it:
This PR adds documentation for using the Volcano plugin for Headlamp from the Volcano website.
The update includes:

  • An Ecosystem page introducing Headlamp on Volcano
  • A User Guide page for installing the plugin from the Headlamp Plugin Catalog
  • Supported Volcano resources shown in Headlamp
  • Verification commands for Volcano Jobs, Queues, PodGroups, JobTemplates, and JobFlows
  • Screenshots showing the Plugin Catalog, Volcano sidebar, Jobs view, Job details, and resource map
  • References to Headlamp installation, plugin packaging docs, and the Volcano Headlamp plugin source
    This helps users discover and use the Headlamp plugin as a UI option for inspecting Volcano scheduling resources from an existing Kubernetes UI.

@volcano-sh-bot volcano-sh-bot added the kind/documentation Categorizes issue or PR as related to documentation. label May 13, 2026
@volcano-sh-bot
Copy link
Copy Markdown
Collaborator

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign kevin-wangzefeng for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@volcano-sh-bot
Copy link
Copy Markdown
Collaborator

Welcome @mahmoudmagdy1-1! It looks like this is your first PR to volcano-sh/website 🎉

@volcano-sh-bot volcano-sh-bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label May 13, 2026
Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request introduces documentation for the Volcano Headlamp plugin, adding an introductory overview and a detailed user guide. The new content covers the plugin's features, installation steps, supported resources, and integration with the Headlamp resource map. Review feedback suggests improving the consistency and readability of the provided kubectl commands by using resource short names and shorthand flags.

Comment thread content/en/docs/user_guide_how_to_use_headlamp.md Outdated
Comment thread content/en/docs/user_guide_how_to_use_headlamp.md Outdated
Signed-off-by: Mahmoud Magdy <d4rkppl1@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

kind/documentation Categorizes issue or PR as related to documentation. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants