Proposal: Add Tutorials, Demos & Labs Section

[rootsongjc]

Background

The HAMi community is growing, and several contributors have expressed interest in creating and sharing hands-on learning content — including tutorials, demos, and labs — but there is currently no dedicated place for this kind of material on the HAMi website.

Rather than maintaining a separate workshop repository, we believe consolidating everything into the main website would be simpler for both contributors and users, given the current size of the community.

Interested Contributors

The following community members have expressed interest in contributing tutorials, demos, or labs, and also need this content for their own events and learning:

• @mesutoezdil
• @maishivamhoo123
• @saiyam1814

Proposal

Add a new Tutorials section (or similarly named) to the HAMi website to host community-contributed demos, hands-on labs, and step-by-step tutorials.

This section would complement the existing Docs by focusing on practical, scenario-driven content rather than reference documentation.

Open Questions

1. Section naming & scope

What should this section be called, and what content belongs in it? Some options:

Name	Scope
Tutorials	Step-by-step guides, may overlap with "Get Started" in Docs
Labs	Hands-on exercises, more structured and numbered
Learn	Broader umbrella — tutorials, videos, demos, workshops
Demos	Focused on runnable examples and sample configs

Should we pick one, or combine them (e.g. "Tutorials & Labs")?

2. Content organization

How should content be structured within this section? Options:

• By topic: GPU sharing, scheduling, monitoring, multi-GPU, etc.
• By difficulty: beginner -> intermediate -> advanced
• By device type: NVIDIA, Cambricon, Ascend, etc.
• Flat list: just numbered labs like lab-01-install, lab-02-gpu-sharing

A hybrid approach (topic + difficulty tags) might work well with Docusaurus doc tags.

3. Docusaurus implementation

How should this integrate with the existing site?

• Option A: New docs instance — a separate Docusaurus docs plugin instance (like the existing docs and case-studies), with its own sidebar and route prefix (e.g. /tutorials/). This keeps tutorials independent from reference docs.
• Option B: Sub-section in existing docs — add tutorials as a category within the current docs sidebar. Simpler but may bloat the docs navigation.
• Option C: Custom plugin/page — build a custom section with filtering, tags, and author attribution. More effort but better UX if the section grows.

4. Custom theme or styling?

Should we develop custom Docusaurus components for this section? For example:

• A lab card grid on the landing page (similar to workshop sites)
• Difficulty badges (beginner, intermediate, advanced)
• Estimated time and prerequisites per lab
• Author attribution (show who contributed each tutorial)

Or should we keep it simple and just use the default docs layout initially?

5. Contribution workflow

• Should tutorials require a template or structured frontmatter?
• Do we need a review process (e.g. at least one maintainer approval)?
• How do we handle content in both English and Chinese (same as existing i18n setup)?

6. Migration from hami-workshop

There is existing workshop content at Project-HAMi/hami-workshop that could be migrated here. Questions:

• Should we migrate the content and archive that repo?
• Or keep them separate for now?

Next Steps

1. Discuss and agree on naming, scope, and structure
2. Decide on Docusaurus implementation approach
3. Define a contribution template for new tutorials/labs
4. Start migrating or creating initial content

Thoughts and feedback welcome from all community members.

/cc @archlitchi @mesutoezdil @maishivamhoo123 @saiyam1814

[maishivamhoo123]

I personally feel "Learn" would be the best choice because it provides a much broader umbrella for educational content. It will include the things like :- Tutorials , KubeCon talks and recordings , Hands-on Labs , and others.
can we keep something like this (vCluster)

[yanghangliu]

[1] Is there a place where community members can submit the requests or suggestions for tutorials?

For example, I really need the Tutorials of mock device plugin. And I think this would be helpful for newbies or beginners who are interested in HAMi but lack actual hardware.

[2] Is there a way for community members to contribute to HAMi tutorial ? If we can send the PR for tutorial, which reviewers should we add ?

[maishivamhoo123]

[1] Is there a place where community members can submit the requests or suggestions for tutorials?

For example, I really need the Tutorials of mock device plugin. And I think this would be helpful for newbies or beginners who are interested in HAMi but lack actual hardware.

[2] Is there a way for community members to contribute to HAMi tutorial ? If we can send the PR for tutorial, which reviewers should we add ?

Great to hear you're interested in contributing! For now, you can add tutorial requests or suggestions as a comment on this issue, and in the future we can also use dedicated issues for them.

And yes, community contributions are welcome. Feel free to open a PR for a tutorial, and the maintainers/reviewers will review it through the normal process.

[mesutoezdil]

Background

The HAMi community is growing, and several contributors have expressed interest in creating and sharing hands-on learning content — including tutorials, demos, and labs — but there is currently no dedicated place for this kind of material on the HAMi website.

Rather than maintaining a separate workshop repository, we believe consolidating everything into the main website would be simpler for both contributors and users, given the current size of the community.

Interested Contributors

The following community members have expressed interest in contributing tutorials, demos, or labs, and also need this content for their own events and learning:

• @mesutoezdil
• @maishivamhoo123
• @saiyam1814

Proposal

Add a new Tutorials section (or similarly named) to the HAMi website to host community-contributed demos, hands-on labs, and step-by-step tutorials.

This section would complement the existing Docs by focusing on practical, scenario-driven content rather than reference documentation.

Open Questions

1. Section naming & scope

What should this section be called, and what content belongs in it? Some options:

Name Scope
Tutorials Step-by-step guides, may overlap with "Get Started" in Docs
Labs Hands-on exercises, more structured and numbered
Learn Broader umbrella — tutorials, videos, demos, workshops
Demos Focused on runnable examples and sample configs
Should we pick one, or combine them (e.g. "Tutorials & Labs")?

2. Content organization

How should content be structured within this section? Options:

• By topic: GPU sharing, scheduling, monitoring, multi-GPU, etc.
• By difficulty: beginner -> intermediate -> advanced
• By device type: NVIDIA, Cambricon, Ascend, etc.
• Flat list: just numbered labs like lab-01-install, lab-02-gpu-sharing

A hybrid approach (topic + difficulty tags) might work well with Docusaurus doc tags.

3. Docusaurus implementation

How should this integrate with the existing site?

• Option A: New docs instance — a separate Docusaurus docs plugin instance (like the existing docs and case-studies), with its own sidebar and route prefix (e.g. /tutorials/). This keeps tutorials independent from reference docs.
• Option B: Sub-section in existing docs — add tutorials as a category within the current docs sidebar. Simpler but may bloat the docs navigation.
• Option C: Custom plugin/page — build a custom section with filtering, tags, and author attribution. More effort but better UX if the section grows.

4. Custom theme or styling?

Should we develop custom Docusaurus components for this section? For example:

• A lab card grid on the landing page (similar to workshop sites)
• Difficulty badges (beginner, intermediate, advanced)
• Estimated time and prerequisites per lab
• Author attribution (show who contributed each tutorial)

Or should we keep it simple and just use the default docs layout initially?

5. Contribution workflow

• Should tutorials require a template or structured frontmatter?
• Do we need a review process (e.g. at least one maintainer approval)?
• How do we handle content in both English and Chinese (same as existing i18n setup)?

6. Migration from hami-workshop

There is existing workshop content at Project-HAMi/hami-workshop that could be migrated here. Questions:

• Should we migrate the content and archive that repo?
• Or keep them separate for now?

Next Steps

1. Discuss and agree on naming, scope, and structure
2. Decide on Docusaurus implementation approach
3. Define a contribution template for new tutorials/labs
4. Start migrating or creating initial content

Thoughts and feedback welcome from all community members.

/cc @archlitchi @mesutoezdil @maishivamhoo123 @saiyam1814

Great idea!

Of course, every submitted contribution must have been tested and verified to work.
To prevent the repository from turning into a pile of AI-generated junk, the relevant contribution guidelines are available here: https://project-hami.io/docs/contributor/contributing#ai-usage

[saiyam1814]

WE have the tutorials section love now! https://project-hami.io/tutorials lets keep adding more labs and tutorials - create issue first and then implementations in the same format.

[rootsongjc]

Thank you! We’ll continue to use “Tutorials” as the section title. I’ll translate “lab3” and “lab4” into Chinese. @saiyam1814

[mesutoezdil]

The tutorials section is live and has 4 labs. The contribution template is also in place. I have private labs, can add afterwards.

1 gap: there are no Chinese translations yet. The i18n/zh/tutorials/ directory does not exist. All 4 labs are English only right now.

@rootsongjc you mentioned translating lab3 and lab4 to Chinese. Is that still planned? If so, happy to help with the other 2 labs once the structure is in place.

@saiyam1814 @maishivamhoo123 @yanghangliu

[rootsongjc]

i18n/zh/docusaurus-plugin-content-docs-tutorials we have 6 labs now, all of them have been translated. @mesutoezdil

[mesutoezdil]

i18n/zh/docusaurus-plugin-content-docs-tutorials we have 6 labs now, all of them have been translated. @mesutoezdil

Awesome! Could you share the titles of the labs scheduled for the coming days here?

[rootsongjc]

@maishivamhoo123 want to write a lab after this PR merged Project-HAMi/HAMi#1773 and @shivaylamba want to write a SGLang lab.