[LFX 2025 Term2]Enhance Volcano Official Documentation

[Monokaix]

What is the problem you're trying to solve

As Volcano's functionality grows and its integration with the broader ecosystem deepens, the community documentation needs to be updated and iterated upon to provide better user guidance and experience. Clear and comprehensive documentation helps users quickly get started with Volcano and reduces the cost of usage and configuration. Currently, some documentation is scattered across the GitHub repository and needs to be migrated to the official website to provide a unified entry point for users.

Describe the solution you'd like

1. Documentation Migration: Migrate the documentation from the GitHub repository that is not yet on the official website to the official website.
2. Component Documentation: Provide detailed explanations of the functionality of Volcano Scheduler, Volcano Controller, Volcano Agent, and Volcano Admission components, including the meaning of their respective startup parameters.
3. Core Feature Documentation: Supplement the documentation for core features such as JobFlow and vGPU virtualization.
4. Best Practices: Add a "Best Practices" section offering recommendations and configuration examples for using Volcano in various scenarios.
5. Troubleshooting: Include a "Troubleshooting" section that collects and organizes common issues and their solutions.

This will result in more complete and accessible documentation, improving the user experience and facilitating wider adoption of Volcano.

Additional context

No response

[d-aggarwal]

Hi @Monokaix

I'm Drishti, interested in contributing to this project . I have a background in web development and CI/CD from my Data Engineer Intern at Amazon and I've been actively exploring Kubernetes.

This issue looks like a great opportunity to deepen my knowledge while Enhance Volcano Official Documentation. I'd appreciate any guidance on how to get started.

Looking forward to contributing!

Thanks

[nitresilient]

Hii I'm really interested in contributing to this project. I see this issue as a great opportunity to get involved with Volcano and help improve its official documentation.

I'm particularly excited about the chance to work on organizing and migrating the documentation, and to contribute towards making it more accessible and helpful for the community. Started looking into issues to understand the codebase, will try to contribute soon. If there is any discussion regarding this project, i would like to join that. Thanks.

[Monokaix]

Thanks! You can first read the Volcano docs both at https://github.com/volcano-sh/volcano/tree/master/docs/user-guide and https://volcano.sh/en/docs/v1-11-0/ to getting start with Volcano! @d-aggarwal @nitresilient

[yashpawar6849]

Hi @Monokaix ,

I'm Yash, and I'm interested in contributing to this project. I have experience in web development and technical documentation through various projects, and I've been actively exploring Kubernetes,ArgoCD and also contributed to some of the cncf repos.

This issue seems like a great opportunity to enhance the Volcano official documentation while deepening my understanding. I'd really appreciate any guidance on how to get started.

Looking forward to contributing!

Thanks!

[subhramit]

@Monokaix this comment is to warn against the spammer @yashpawar6849. Please check this comment by Prometheus maintainer Björn Rabenstein.

@yashpawar6849 Hi, not a maintainer here but was taking a walk around CNCF.

I'm Yash, and I'm interested in contributing to this project. I have experience in web development and technical documentation through various projects, and I've been actively exploring Kubernetes,ArgoCD and also contributed to some of the cncf repos.

Your GitHub, on first look, seems very impressive - so many organizations contributed to! However, on checking out your contributions, it appears that your entire GitHub is a sham. You have literally opened the same issue everywhere and just changed project names: https://github.com/spiffe/spiffe/issues/337 https://github.com/theupdateframework/python-tuf/issues/2827 https://github.com/prometheus/prometheus/issues/16489 and everywhere else.

You have never contributed a single line of code to any of the popular organizations on your profile. To get the organization labels on your GitHub, you have either done that or blank-approved random PRs where you had no business. Your biggest contribution so far is where you fixed a spelling error at https://github.com/cncf/cartografos/pull/78.

You understand that all of this is recorded and visible in GitHub history, right?

How about you stop wasting maintainers' time by spamming and actually learn a thing or two beyond spellings? If we see you spamming anywhere else we shall CNCF authorities to get you banned from their programs and repositories.

Thanks!

[Monokaix]

@Monokaix this comment is to warn against the spammer @yashpawar6849. Please check this comment by Prometheus maintainer Björn Rabenstein.

@yashpawar6849 Hi, not a maintainer here but was taking a walk around CNCF.

I'm Yash, and I'm interested in contributing to this project. I have experience in web development and technical documentation through various projects, and I've been actively exploring Kubernetes,ArgoCD and also contributed to some of the cncf repos.

Your GitHub, on first look, seems very impressive - so many organizations contributed to! However, on checking out your contributions, it appears that your entire GitHub is a sham. You have literally opened the same issue everywhere and just changed project names: spiffe/spiffe#337 theupdateframework/python-tuf#2827 prometheus/prometheus#16489 and everywhere else.

You have never contributed a single line of code to any of the popular organizations on your profile. To get the organization labels on your GitHub, you have either done that or blank-approved random PRs where you had no business. Your biggest contribution so far is where you fixed a spelling error at cncf/cartografos#78.

You understand that all of this is recorded and visible in GitHub history, right?

How about you stop wasting maintainers' time by spamming and actually learn a thing or two beyond spellings? If we see you spamming anywhere else we shall CNCF authorities to get you banned from their programs and repositories.

Thanks!

Thanks for share the information, we're an open community and welcome everyone to contribute under the code of conduct, but we will also evaluate the resumes and information of LFX Mentorship applicants to select a suitable mentee: )

[yashpawar6849]

@subhramit

Thank you sir for declaring me as a spammer.

Regards

[yashpal2104]

Hi I am Yash Pal, excited to meet the volcano community and apply to the project of improving docs for volcano. I have a zeal to learn and discipline to follow through with actions.

[Nidhi1314]

Hi @Monokaix,

I’m Nidhi Shekhawat, excited to join the Volcano community and contribute to improving the documentation. I have experience in technical writing and open source through my contributions to GirlScript Summer of Code, where I worked on documentation and frontend improvements and have been an active contributor in the organization.

With my previous contributions, I believe I am proactive in enhancing documentation quality and attentive to details.

I look forward to helping migrate and enhance Volcano’s docs with comprehensive explanations and learning through this journey. I'd appreciate any guidance to get started.

Thanks, Nidhi

[waghgauri14]

Hi @Monokaix,

I'm Gauri Wagh, I'd be thrilled to join and contribute Volcano community. My tech stack includes ReactJS, Data Scrapping, Data Analysis, Machine Learning, SQL, C++. During my internship and contributing to technical teams at my college, I have learned to use various Microsoft tools like Azure Data Studio, Learning Platforms, Developer tools in AI. Along with this I have helped build websites and am knowledgeable in frontend development.

I recently applied to Volcano through the LFX Mentorship program and am keen to join the team. With a background in Python, React front‑end development, I can consolidate scattered content into clear, navigable guides, add best‑practice examples, and organize troubleshooting tips. I’m eager to put these skills to work and help build a unified, user‑friendly knowledge base for the Volcano community.

Looking forward to contribute! Thank You!

[eyeaadil]

Hi @Monokaix, Could you please confirm whether this issue has been implementing in the website repository? If not, would you recommend implementing it in a separate repository or in the dashboard repository? Your guidance would be greatly appreciated.

[Monokaix]

Hi,all. Thanks for your interest!

The primary goal of this project is to improve and complete Volcano's official website documentation. This mainly involves adding and modifying Markdown files within the website repository.

Here's a breakdown of the work:

• Migration: Some documents can be directly copied from the docs/user-guide directory of the main Volcano repository.
• Supplementation: Crucially, descriptions for missing functionalities need to be added.
• Updates: Existing, outdated documentation requires thorough updates.

To successfully contribute to this project, applicants must have a solid understanding of Volcano's various features. This is critical. Additionally, familiarity with the current structure of the Volcano website and strong documentation writing skills are essential.

If this sounds like a good fit, feel free to apply directly!

[YashGupt29]

Hi @Monokaix
Thank you for outlining the scope of the documentation improvement initiative. I wanted to confirm one point before proceeding: Should all the relevant Markdown files currently under docs/user-guide in the main volcano-sh/volcano repository be migrated directly into the Hugo-based volcano-sh/website repository (under content/docs or another appropriate directory), and enhanced there as part of the contribution? Additionally, would you prefer contributors to propose structural changes (e.g., organizing by components or features) in the same PR, or focus solely on a 1:1 migration in the first phase? Looking forward to your guidance so I can align my work accordingly.