EnvisEdge icon indicating copy to clipboard operation
EnvisEdge copied to clipboard

📚 Documentation: Changing type of Federated Learning into bullet points and providing and short description to it

Open haripriya9647 opened this issue 2 years ago • 25 comments

🙋 Where

https://github.com/NimbleEdge/EnvisEdge/blob/main/docs/source/tutorials/Tutorial-Part-1-introduction_to_fl.rst

💭 Description

Types should be converted into bullet points and a proper short description should be provided Refer to this resource link Line no - 20,21

👀 Have you spent some time checking if this issue has been raised before?

  • [X] I checked and didn't find similar issue

🏢 Have you read the guidlines?

  • [X] I have read the Guildlines

🏢 Have you read the Code of Conduct?

  • [X] I read the Code of Conduct

haripriya9647 avatar May 03 '22 05:05 haripriya9647

Hey, can I work on this issue. Or is it assigned to anyone else?

burpcat avatar May 03 '22 08:05 burpcat

Hey @burpcat its not assigned to anyone yet.Just take confirmation from @ramesht007 once before working on this

haripriya9647 avatar May 03 '22 08:05 haripriya9647

@ramesht007 Can i work on this?

burpcat avatar May 03 '22 08:05 burpcat

Thanks @haripriya9647 for suggesting a better documentation type. Sure @burpcat you can go ahead and improve it. I am assigning @burpcat @haripriya9647 both to this issue so that you can collaborate and work on this issue to imporve the content.

ramesht007 avatar May 04 '22 04:05 ramesht007

Feel free to have open discussion about it on discord on #EnvisEdge channel. So everyone can take part in it. thanks

ramesht007 avatar May 04 '22 04:05 ramesht007

@burpcat can you ping me once in discord

haripriya9647 avatar May 04 '22 08:05 haripriya9647

Hey @ramesh, I would like to work with @haripriya9647 to improve the grammar and language of this document using the professional Grammarly tool.

Please assign the issue to us.

Thanks

abhiwalia15 avatar May 05 '22 17:05 abhiwalia15

I can assist if the task is a large on @ramesht007

Tob-iee avatar May 05 '22 19:05 Tob-iee

I can assist if the task is a large on @ramesht007

Please assign the issue to me. I would like to work on this with @haripriya9647. I have taken consent from @ramesht007 on this. Thanks

abhiwalia15 avatar May 05 '22 22:05 abhiwalia15

I don't have the ability to assign tasks please

Tob-iee avatar May 06 '22 01:05 Tob-iee

Okay, So I fixed the federated learning bullet points issue. Now what are we looking at exactly? @abhiwalia15

burpcat avatar May 06 '22 10:05 burpcat

  • I spotted a broken link in the README file under the Demos and tutorials section. The link should be directed to a folder where tutorials and demos documents are.

EnvisEdge1

This should be the correct link - https://github.com/NimbleEdge/EnvisEdge/tree/main/docs/source/tutorials

dchidindu5 avatar May 06 '22 13:05 dchidindu5

@ramesht007 I'd also like to improve this document, I've found some typo errors here too. Introduction to Federated Learning

dchidindu5 avatar May 06 '22 13:05 dchidindu5

go ahead @dchidindu5

ramesht007 avatar May 06 '22 14:05 ramesht007

Okay, So I fixed the federated learning bullet points issue. Now what are we looking at exactly? @abhiwalia15

I will run the entire content through Grammarly to check for language and grammar mistakes.

abhiwalia15 avatar May 06 '22 15:05 abhiwalia15

@dchidindu5 @abhiwalia15 @haripriya9647

So, Im fixing all the broken links in "Tutorials" part of the EnvisEdge documentation. Any conflicts let me know.

burpcat avatar May 06 '22 15:05 burpcat

@ramesht007 I'd also like to improve this document, I've found some typo errors here too. Introduction to Federated Learning

I am woking on the typos for this tutorial 1, please work on other tutorials as it will cause confusion and conflicts.

abhiwalia15 avatar May 06 '22 16:05 abhiwalia15

I would like to continue working on the Deployment tutorial. I have noticed some other errors @ramesht007. https://docs.nimbleedge.ai/tutorials/tutorial-part-4-deployment#

AIgbine avatar May 07 '22 21:05 AIgbine

@abhiwalia15 I'm working on that already

dchidindu5 avatar May 07 '22 21:05 dchidindu5

@ramesht007 Please review my pull request I made a correction to tutorial 4 #250

dchidindu5 avatar May 07 '22 22:05 dchidindu5

Currently working to improve tutorial 5 @ramesht007

dchidindu5 avatar May 07 '22 22:05 dchidindu5

Currently working to improve tutorial 5 @ramesht007

dchidindu5 avatar May 08 '22 21:05 dchidindu5

@ramesht007 I Fixed series of typo errors and improved the docs in Tutorial 5 (Local training.rst) #259

dchidindu5 avatar May 10 '22 16:05 dchidindu5

@ramesht007 please review and merge my pull requests #259

dchidindu5 avatar May 12 '22 23:05 dchidindu5

@ramesht007 please review and merge my pull requests #259

left some comments please fix thanks

ramesht007 avatar May 22 '22 14:05 ramesht007