kusion icon indicating copy to clipboard operation
kusion copied to clipboard

Help us improve the quality of our website documentation and code comments in English

Open SparkYuan opened this issue 1 year ago • 7 comments

As none of our current maintainers are native English speakers, it's inevitable that there are mistakes in our website and code comments. To make sure that our users can clearly understand our work, we would greatly appreciate your help in improving the quality of our documentation.

  • For code comments, you can submit pull requests to this repo directly.
  • For website documentation, you can submit pull requests in the website repo

SparkYuan avatar Jun 14 '24 09:06 SparkYuan

Hello @SparkYuan I'm Ekjot from India I'm very fluent in English and also a developer I came to know about your project through CNCF Slack channel and would like to contribute to the project and become a major contributor in the project. I have expertise in GO as well as I can help to improve Documentation. Please provide me more information so that I can help with it ASAP and also do code contributions. Thankyou

ekjotsinghmakhija avatar Jul 26 '24 14:07 ekjotsinghmakhija

@ekjotsinghmakhija Welcome to our community! Here is a doc about our community roles. When you meet the requirements, you will automatically become a contributor.

You can visit our website to get more details about our project and start with issues labeled with good first issue or help wanted. Feel free to contact me if you have any questions.

SparkYuan avatar Jul 26 '24 14:07 SparkYuan

Hey @SparkYuan & @ffforest

Can i pick this up ?

Iamrushabhshahh avatar Mar 23 '25 20:03 Iamrushabhshahh

Hi, @Iamrushabhshahh , welcome to Kusion. 🎉🎉🎉

This is a long-term issue and contributions from everyone are welcome. You can directly submit Merge Requests for code comments and website documentation to this repo and website repo

ruquanzhao avatar Apr 01 '25 03:04 ruquanzhao

Hey @ruquanzhao ,

I’ve started working on a PR 603 and here’s a preview of it: Vercel Preview. I would really appreciate your input here so i can move further. I've managed to set it up locally, but building it has been a bit tedious. Any tips you can share would be really helpful!

Also, when we discuss improving the documentation, are we referring to the docs for Kusion, Karpor, Kuperator, and so on right.

Looking forward to your feedback!

Iamrushabhshahh avatar Apr 01 '25 19:04 Iamrushabhshahh

Perhaps @ffforest can review the English modifications in this PR #603 , in fact, other projects of KusionStack also have the need to optimize documentation, such as https://github.com/KusionStack/karpor/issues/468, you can submit a PR to the project you are interested in, and we welcome it very much!

elliotxx avatar Apr 02 '25 03:04 elliotxx

Sure, @elliotxx,

I'll review it and submit a PR. Thanks for sharing.

Iamrushabhshahh avatar Apr 02 '25 08:04 Iamrushabhshahh