[lfx-mentorship-2025-Mar-May] Re-design and implement the Kmesh website

[LiZhenCheng9527]

• Description: The existing Kmesh website theme struggled to meet existing development needs. Therefore, there is a need to redesign the Kmesh website and replace the theme to make it easier for developers to add documentation. Development instructions for the website are also provided.
• Expected Outcome:
  • The website has more readable documentation, covering user cases, developer courses, etc.
  • Docs about how to develop website.
• Recommended Skills: JS, Kmesh, Html
• Mentor(s): LiZhenCheng9527(@LiZhenCheng9527 , [email protected])
• Useful links:
  • https://github.com/kmesh-net/website/blob/main/README.md

[Shrutim1505]

hi @LiZhenCheng9527 I am Shruti Murthy, interested in working in your project. I would love to connect with you and learn more on it.

[Murdock9803]

I am also looking forward to work on this issue 🙌
Being passionate about development and design, I find myself a good fit for this 🙌 Let's learn together!

[eyeaadil]

Hi @LiZhenCheng9527 , I’m excited and interested to contribute to this issue.
With my passion for development and design, I believe I’m a great fit for this. Let’s grow and learn together!

[DeshDeepakKant]

@LiZhenCheng9527
I would like to work on this issue as it aligns perfectly with my skill set and interests. I have experience with JavaScript, HTML, and website development, which makes me confident in my ability to handle the tasks involved in this project.

I have already started contributing to the Kmesh website and am eager to continue improving it to enhance its usability and ensure better documentation accessibility.

[harshita9104]

Hello @LiZhenCheng9527 ,

This project interests me , i would like to contribute to it!!

[TenzDelek]

Hello @LiZhenCheng9527 , this is Tenzin, a UI Developer , I am happy to write this note to share my desire to be a part of this mentorship to learn and grow in this field. I have noted the requirements for this project and will try to understand it as soon as possible.
Participating in this project as a part of LFX mentorship program would be a huge opportunity for me to contribute and explore with other senior developers and learn from them as well.

I am ready to make a positive contribution to this collaboration and also in the mean time, will be looking into the codebase for better understanding of the environment...
with Regards
Tenzin Delek

[DeshDeepakKant]

Hi @LiZhenCheng9527,

I noticed that Kmesh is using the Academia theme, which is outdated (last updated 3 years ago) and costs $77. To improve maintainability and performance, I suggest switching to a modern Hugo theme.

I found Doks, a free, well-maintained theme designed for documentation sites. It offers a clean design, fast performance, built-in SEO, and regular updates—making it a great fit for Kmesh.

Would you like me to explore other options, or does this sound good to you?

[DeshDeepakKant]

@LiZhenCheng9527
In this project, I wanted to clarify the scope of work. Are we expected to focus solely on redesigning the website and replacing the theme, or should we also expand the expected outcomes by enhancing documentation (e.g., covering user cases, developer courses, and adding development instructions)?

[LiZhenCheng9527]

@LiZhenCheng9527 In this project, I wanted to clarify the scope of work. Are we expected to focus solely on redesigning the website and replacing the theme, or should we also expand the expected outcomes by enhancing documentation (e.g., covering user cases, developer courses, and adding development instructions)?

I apologize for not being able to make it clear what needs to be accomplished.
The main task is to change the website theme and optimize the website. The usage documentation for the features is a secondary task. Later, I will list the tasks that need to be completed for this LFX in this PR. We will decide on the LFX Mentee for this quarter within the next two days.

Everyone is very enthusiastic about participating in the LFX project, but only one Mentee can be selected for a project. Therefore, I will make a decision as soon as possible to save everyone's time. Meanwhile, I appreciate everyone's efforts during this period and welcome you all to continue participating, progressing together.

[DeshDeepakKant]

Hi @LiZhenCheng9527

Thanks for the clarification. Since the main task is to change the website theme, I focused on researching the best options. The current academic theme is outdated (around three years old), so after evaluating various Hugo themes, I concluded that Doks is the best fit.

Several CNCF projects use similar Doks-based themes, as it is modern, well-optimized, and well-suited for documentation-heavy projects. Here's an example of how it would look:

https://thulite.io/

I worked throughout the entire night to create a KMesh preview using the Doks theme. While I successfully set it up, I couldn't make it live due to some issues. I am actively working on resolving them and will share the preview by this evening.

Regarding my user guide PR, I was taking time to understand both the KMesh project and Hugo framework to ensure meaningful updates. I’ll be updating the PR within a few hours.

By the way, I also reached out to you on Slack earlier regarding this. Since we are moving towards a complete theme change, making modifications to the current website may not be the best use of time.

I’d appreciate your feedback and guidance on the theme choice and implementation approach. Let me know if you have any suggestions!

Looking forward to your thoughts.

[LiZhenCheng9527]

LFX tasks：

• Changing the theme of the Kmesh website.
• Merge existing feature docs and blogs.
• Create sidebars to provide intuitive navigation for Kmesh.
• Creating a Guide for Document Management/Creation.
• Implementing a Blog Sidebar.
• Update README.md about Kmesh and Quick Start.

Other page optimizations are optional.

[Emily-Li-Xinling]

Hiiii @LiZhenCheng9527 , I’m Xinling Li. I’m very excited for the opportunity to contribute to this repository under your mentorship. No matter whether I get selected or not, I will definitely keep following its progress. Looking forward to getting started!

[LiZhenCheng9527]

Thank you all for your active participation in this project. Everyone is truly excellent and has made their own contributions to the optimization of the Kmesh-website. However, only one student can be selected for this quarter's LFX project. Although I enjoy the lively atmosphere in our community, in order for everyone to have the opportunity to participate in LFX, I believe I should make the decision for the selected student for this project's LFX as soon as possible.

That student is @jayesh9747 .

I was faced with a difficult decision as everyone is truly excellent. However, @jayesh9747 actively communicated with me, clearly understood the specific requirements, and quickly started the work on changing the website theme, which has already shown initial results. Therefore, I ultimately chose him.

Finally, thank you all for your enthusiastic participation, and we welcome everyone to continue contributing to the Kmesh project.

/assign @jayesh9747

[kmesh-bot]

@LiZhenCheng9527: GitHub didn't allow me to assign the following users: jayesh9747.

Note that only kmesh-net members with read permissions, repo collaborators and people who have commented on this issue/PR can be assigned. Additionally, issues/PRs can only have 10 assignees at the same time.
For more information please see the contributor guide

In response to this:

Thank you all for your active participation in this project. Everyone is truly excellent and has made their own contributions to the optimization of the Kmesh-website. However, only one student can be selected for this quarter's LFX project. Although I enjoy the lively atmosphere in our community, in order for everyone to have the opportunity to participate in LFX, I believe I should make the decision for the selected student for this project's LFX as soon as possible.

That student is @jayesh9747 .

I was faced with a difficult decision as everyone is truly excellent. However, @jayesh9747 actively communicated with me, clearly understood the specific requirements, and quickly started the work on changing the website theme, which has already shown initial results. Therefore, I ultimately chose him.

Finally, thank you all for your enthusiastic participation, and we welcome everyone to continue contributing to the Kmesh project.

/assign @jayesh9747

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[jayesh9747]

Thank you so much @LiZhenCheng9527 and Community. I will work hard and won't disappoint and eager to make more contibutions in this organisation.

[Murdock9803]

@jayesh9747 Congratulations 🎊🎊
All the very best for the project work ahead. I am excited to see the new Kmesh site, and your interpretation of it. If anytime you feel someone's need, I will be happy to help. Once again, congratulations 🙌🥇

Great decision @LiZhenCheng9527 🙌

[jayesh9747]

@Murdock9803 Thank you very much.

[jayesh9747]

Projects Goals

Week 1

• Implement zooming on double-click for images
• Add KMesh website to Google Analytics
• Create a GitHub task/PR for switching between different releases of docs