layotto icon indicating copy to clipboard operation
layotto copied to clipboard

Add usage document for go sdk; 为 go sdk 添加使用文档

Open seeflood opened this issue 3 years ago • 6 comments

What would you like to be added: Add usage document for go sdk. Currently we don't have user document for go-sdk,see chinese doc and english doc. The content of the document is not restricted,as long as we can teach users how to use it. You can take Dapr's document as a good example and reference.

Why is this needed: Users don't know how to use Layotto without document

seeflood avatar Sep 20 '21 05:09 seeflood

Please assign it to me, I will be happy to write this document and this work will be completed within a week.

arcosx avatar Sep 24 '21 07:09 arcosx

Cool ! @arcosx Already assigned.Thanks for your passion

seeflood avatar Sep 24 '21 11:09 seeflood

@arcosx Hi, are u still working on it?

seeflood avatar Jun 14 '22 08:06 seeflood

I'm very sorry for the delay in getting the development team to track this, and I haven't had the time and energy to continue to finish this issue recently.

arcosx avatar Jun 14 '22 09:06 arcosx

@arcosx That's fine! Can we reassign it to others? Since we are going to do a new round of activities, if you don't have time to do it, we want to treat it as an activity task

seeflood avatar Jun 14 '22 09:06 seeflood

@arcosx That's fine! Can we reassign it to others? Since we are going to do a new round of activities, if you don't have time to do it, we want to treat it as an activity task

You are too kind😁, of course you can. Good luck with the activity.

arcosx avatar Jun 14 '22 11:06 arcosx

Hi @seeflood. I'm sorry to bother you so late. I would like to confirm if someone is working on this issue or if the requirement has been abandoned. If not, I am willing to take on this assignment. I am not particularly busy with my studies at this time, so I have sufficient time to complete this job. If I do not submit a PR or comment within a week, you may reassign the task.

cyb0225 avatar Mar 10 '23 15:03 cyb0225

@cyb0225 It's still available. PR welcome !

seeflood avatar Mar 11 '23 00:03 seeflood

Great! I will complete the Chinese version of docs firstly. After you reviewing it, I will then proceed to translate it into English.

cyb0225 avatar Mar 11 '23 02:03 cyb0225

Great! I will complete the Chinese version of docs firstly. After you reviewing it, I will then proceed to translate it into English.

The current golang sdk is too simple, more like a demo display, you can try to refactor the golang sdk like Dapr. Simplify the user's use

wenxuwan avatar Mar 12 '23 03:03 wenxuwan

Great! I will complete the Chinese version of docs firstly. After you reviewing it, I will then proceed to translate it into English.

The current golang sdk is too simple, more like a demo display, you can try to refactor the golang sdk like Dapr. Simplify the user's use

I am willing to give it a try. But I think I may need some time to have a deeper understanding of dapr, layotto, and Mosn. Do I need to complete the tutorial on using the current version of the go-sdk firstly? Or jump right into refactoring work on the go-sdk.

cyb0225 avatar Mar 12 '23 07:03 cyb0225

Great! I will complete the Chinese version of docs firstly. After you reviewing it, I will then proceed to translate it into English.

The current golang sdk is too simple, more like a demo display, you can try to refactor the golang sdk like Dapr. Simplify the user's use

I am willing to give it a try. But I think I may need some time to have a deeper understanding of dapr, layotto, and Mosn. Do I need to complete the tutorial on using the current version of the go-sdk firstly? Or jump right into refactoring work on the go-sdk.

We can complete the construction of the document first, and then try to reconstruct Layotto's Golang sdk after you have a deeper understanding of Layotto。😊

wenxuwan avatar Mar 12 '23 08:03 wenxuwan

I see.

cyb0225 avatar Mar 12 '23 08:03 cyb0225

Hey, after serveral days of reading code, I have found that it's easy for users to use go-sdk connect to layotto and use the a serious of services with interface functions. go-sdk has not expose many interfaces to users. But it's difficult for me to write a config file especially it's my first time contact with service mesh. So I think we may need a document on how to complete a useable config more than a go-sdk using doc.

cyb0225 avatar Mar 16 '23 14:03 cyb0225

Hey, after serveral days of reading code, I have found that it's easy for users to use go-sdk connect to layotto and use the a serious of services with interface functions. go-sdk has not expose many interfaces to users. But it's difficult for me to write a config file especially it's my first time contact with service mesh. So I think we may need a document on how to complete a useable config more than a go-sdk using doc.

Do you mean the configuration file of Layotto?

wenxuwan avatar Mar 17 '23 03:03 wenxuwan

Hey, after serveral days of reading code, I have found that it's easy for users to use go-sdk connect to layotto and use the a serious of services with interface functions. go-sdk has not expose many interfaces to users. But it's difficult for me to write a config file especially it's my first time contact with service mesh. So I think we may need a document on how to complete a useable config more than a go-sdk using doc.

Do you mean the configuration file of Layotto?

Yeah, most of my current configuration items refer to the config of mosn and demo

cyb0225 avatar Mar 17 '23 03:03 cyb0225

Hey, after serveral days of reading code, I have found that it's easy for users to use go-sdk connect to layotto and use the a serious of services with interface functions. go-sdk has not expose many interfaces to users. But it's difficult for me to write a config file especially it's my first time contact with service mesh. So I think we may need a document on how to complete a useable config more than a go-sdk using doc.

Do you mean the configuration file of Layotto?

Yeah, most of my current configuration items refer to the config of mosn and demo

So what you want to do is provide a document that states the configuration options for Layotto?

wenxuwan avatar Mar 17 '23 04:03 wenxuwan

Hey, after serveral days of reading code, I have found that it's easy for users to use go-sdk connect to layotto and use the a serious of services with interface functions. go-sdk has not expose many interfaces to users. But it's difficult for me to write a config file especially it's my first time contact with service mesh. So I think we may need a document on how to complete a useable config more than a go-sdk using doc.

Do you mean the configuration file of Layotto?

Yeah, most of my current configuration items refer to the config of mosn and demo

So what you want to do is provide a document that states the configuration options for Layotto?

Yes. Most of the configuration options can refer to the docs of mosn. I think we can explain how to write the configuration of various middleware for layotto and build the environment, etc. But I'm not sure if this is necessary.

cyb0225 avatar Mar 17 '23 06:03 cyb0225

Hey, after serveral days of reading code, I have found that it's easy for users to use go-sdk connect to layotto and use the a serious of services with interface functions. go-sdk has not expose many interfaces to users. But it's difficult for me to write a config file especially it's my first time contact with service mesh. So I think we may need a document on how to complete a useable config more than a go-sdk using doc.

Do you mean the configuration file of Layotto?

Yeah, most of my current configuration items refer to the config of mosn and demo

So what you want to do is provide a document that states the configuration options for Layotto?

Yes. Most of the configuration options can refer to the docs of mosn. I think we can explain how to write the configuration of various middleware for layotto and build the environment, etc. But I'm not sure if this is necessary.

You are right, contributions are welcome 👏👏

wenxuwan avatar Mar 17 '23 06:03 wenxuwan

Hey, after serveral days of reading code, I have found that it's easy for users to use go-sdk connect to layotto and use the a serious of services with interface functions. go-sdk has not expose many interfaces to users. But it's difficult for me to write a config file especially it's my first time contact with service mesh. So I think we may need a document on how to complete a useable config more than a go-sdk using doc.

Do you mean the configuration file of Layotto?

Yeah, most of my current configuration items refer to the config of mosn and demo

So what you want to do is provide a document that states the configuration options for Layotto?

Yes. Most of the configuration options can refer to the docs of mosn. I think we can explain how to write the configuration of various middleware for layotto and build the environment, etc. But I'm not sure if this is necessary.

You are right, contributions are welcome 👏👏

Thanks for your patience, I'll try to get it done this weekend. :smile::smile:

cyb0225 avatar Mar 17 '23 06:03 cyb0225

@wenxuwan, I have already understanding the process of how layotto running and ready to write the docs. Can I add some docker-compose and config files to the repo for newcomers getting started faster?

cyb0225 avatar Mar 19 '23 12:03 cyb0225

@wenxuwan, I have already understanding the process of how layotto running and ready to write the docs. Can I add some docker-compose and config files to the repo for newcomers getting started faster?

Of course, looking forward to your PR

wenxuwan avatar Mar 19 '23 14:03 wenxuwan