Suggestions for keeping website latest

[yp969803]

The contents for the website are stored in https://github.com/kmesh-net/website/tree/main/content
Meanwhile the latests docs are stored in https://github.com/kmesh-net/kmesh/tree/main/docs

Use docs folder from kmesh repo, as a content for the website

If the files in the docs folder is edited, just do Continous Deployment of the website, hence the website will be updated with latest stuffs.

for ex: If a contributor contributes any feature in kmesh, he have to just edit the markdown in the docs folder and the changes are updated to website realtime.

Also generating markdown with comments in gofile, created the issue for this kmesh-net/kmesh#1264

[yp969803]

@LiZhenCheng9527 @hzxuzhonghu what you all think,

[yp969803]

This opensource project https://github.com/prometheus-operator/prometheus-operator, also uses the same approach

[LiZhenCheng9527]

We have script that automatically generate markdown files based on kmeshctl comments.

https://github.com/kmesh-net/kmesh/blob/main/hack/gen-kmeshctl-doc.sh

What we need is to synchronize these files to the website.

Do you have good idea?

[yp969803]

during generating the site
pulling the documentation contents from kmesh repository (mainly docs folder) and coping the markdowns to the content folder in the website, then build the website, and deploy it

[yp969803]

Taken refrence from the prometheus-operator project https://github.com/prometheus-operator/website/blob/main/synchronize.sh

[yp969803]

@Jayesh0167 can you come up with the plan of how should we implement this, you can take refrence from https://github.com/prometheus-operator/prometheus-operator/tree/main/Documentation and https://github.com/prometheus-operator/website

[jayesh9747]

@yp969803 hey , yash you can see https://github.com/jayesh9747/kmesh-website-v2/tree/kmesh-v2 . it is same like you want, like me command documentation, and it will build the site, i used docusurus for build the web and maintain comman documentation folder.

[yp969803]

@jayesh9747 i didnt see any method you are using to synchronize the docs from kmesh repository,
as mentioned above you can use:

during generating the site
pulling the documentation contents from kmesh repository (mainly docs folder) and coping the markdowns to the content folder in the website, then build the website, and deploy it

[yp969803]

@jayesh9747 https://github.com/prometheus-operator/website/blob/main/synchronize.sh see this script from the prometheus-operator project, what they are doing is during production or local development, cloning lastest project repository and coping markdown from the project to the content of the website repository. We want a solution like this

[LiZhenCheng9527]

Discussion of automatically synchronizing the documentation for the Kmesh main repo. @yp969803 @jayesh9747
The feature proposal documentation is still in the main repo. Move other documents to the website repository. Maintain this documentation in the website repo. You can start by migrating the documentation for kmeshctl.

[yp969803]

@LiZhenCheng9527 as with the solutions i have discussed above, the docs will be only in the kmesh repo , and the migration from the kmesh repo to the website repo will happen using using a script schronize.sh at the time of deployment triggerd by Github actions workflow in kmesh repo. I will come with a end to end plan with automation of most of the stuffs soon currently busy with my exam.