Skip to content

docs: add Headlamp plugin guide#504

Merged
volcano-sh-bot merged 1 commit into
volcano-sh:masterfrom
mahmoudmagdy1-1:docs-headlamp
Jun 2, 2026
Merged

docs: add Headlamp plugin guide#504
volcano-sh-bot merged 1 commit into
volcano-sh:masterfrom
mahmoudmagdy1-1:docs-headlamp

Conversation

@mahmoudmagdy1-1
Copy link
Copy Markdown
Contributor

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

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
@JesseStutler
Copy link
Copy Markdown
Member

Maybe add to the ecosystem is better, and since we have already migrate to use docusarus, could you rebase again? Thanks!

@mahmoudmagdy1-1
Copy link
Copy Markdown
Contributor Author

Thanks! Rebased on the Docusaurus migration and moved the Headlamp documentation into the Ecosystem docs.

@volcano-sh-bot volcano-sh-bot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels May 26, 2026
@illume
Copy link
Copy Markdown

illume commented May 27, 2026

@mahmoudmagdy1-1 maybe add your youtube video from your blog post? It does a good job demoing the different parts IMHO.

@mahmoudmagdy1-1
Copy link
Copy Markdown
Contributor Author

@mahmoudmagdy1-1 maybe add your youtube video from your blog post? It does a good job demoing the different parts IMHO.

Great idea, will do now

Signed-off-by: Mahmoud Magdy <d4rkppl1@gmail.com>
@volcano-sh-bot volcano-sh-bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels May 27, 2026
@mahmoudmagdy1-1
Copy link
Copy Markdown
Contributor Author

@JesseStutler PTAL when you can

@JesseStutler
Copy link
Copy Markdown
Member

So cool, thanks!
/approve
/lgtm

@volcano-sh-bot volcano-sh-bot added the lgtm Indicates that a PR is ready to be merged. label Jun 2, 2026
@volcano-sh-bot
Copy link
Copy Markdown
Collaborator

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: JesseStutler

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

The pull request process is described 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 volcano-sh-bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jun 2, 2026
@volcano-sh-bot volcano-sh-bot merged commit 0f705da into volcano-sh:master Jun 2, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. kind/documentation Categorizes issue or PR as related to documentation. lgtm Indicates that a PR is ready to be merged. 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.

4 participants