Umbrella Issue for KubeEdge Documentation restructuring

[RyanZhaoXB]

Description

Hello, guys. We are restructuring the documentation of KubeEdge. We want to supply more documentation about How to Use KubeEdge. We summarized some task items as follows for KubeEdge documentation, please comment with one or more items' names if you are interested to join.

Tasks

• [ ] Setup
  • off-line installation @RyanZhaoXB
  • How to deploy HA cloudcore in kubernetes
  • Introduction about the sub-commands of keadm
  • How to upgrade the component of KubeEdge remotely
  • Intdoduction about the configuration files of cloudcore and edgecore
  • How to use Domain Name to configure the advertise address of cloudcore
  • How to use Docker as the container runtime instead of containerd when using v1.13
• [ ] Monitoring
  • Edge Node Monitoring Solution with Metrics-Server and Prometheus
  • How to check the logs of cloudcore and edgecore
• [ ] Node Group Management
  • How to manage the node group
• [ ] Device Management
  • How to add a device @RyanZhaoXB
  • How to manage devices with DMI @RyanZhaoXB
  • How to manage devices of modbus, opcua or other protocol with the mapper provided by community
  • How to develop of mapper of my own
• [ ] Router
  • eventbus to rest with yaml and demo
  • servicebus to rest with yaml and demo @RyanZhaoXB
  • rest to eventbus with yaml and demo
  • rest to servicebus with yaml and demo
• [ ] Security
  • the management of certification and secret
  • Large-scale Test
• [ ] EdgeSite
  • How to use EdgeSite? Deployment and Usage
• [ ] Developer
  • How to update and verify the CRD files
  • How to build the binary and images of the components
  • How to use local-up script to pull up a local cluster for development
• [ ] Case Studies
  • supply some use cases of KubeEdge
• [ ] Community
  • add some community activities such as KEAW22 or KubeEdge Summit or other activities
• [ ] Training
  • add the information of KubeEdge Course
• [ ] FAQ
  • supply some frequently asked questions

Please feel free to tell us if you have any idea or suggestion.

[shenguangfu0906]

service bus 从edge端到cloud端无文档 #4628 service bus 文档缺少 只有cloud 到 edge的文档，没有edge到cloud文档

[RyanZhaoXB]

I will finish servicebus to rest with yaml and demo these days and supply some documentation about device management.

[Kanika637]

I would like to contribute in any way possible. Can you guide me a little from where can I start? @RyanZhaoXB

[Nupoor10]

Hey, I am interested in contributing to this issue. Are there any tasks that I can contribute to as a beginner? Perhaps community or case studies? Any guidance would be highly appreciated. Thanks!

[RyanZhaoXB]

Hello @Kanika637 and @Nupoor10 . Welcom to the Community of KubeEdge. KubeEdge is a cloud native edge computing platform which expands the ability of Kubernetes from cloud to edge and it is managed by CNCF. You can find more about KubeEdge in our website https://kubeedge.io. And this website is also the target of this issue.

As a starter, you can supply some use cases about how to use KubeEdge or add some information of community activities such as KubeEdge Course to the website. To contribute to this issue, you can update the document of https://github.com/kubeedge/website/tree/master/content/en and propose a PR to the master repository.

Please feel free to tell me if you have any further question. Thanks for your contribute!

[Nupoor10]

Heyy! Sure, I will look into what I can add and make a PR soon. Thank you!

[stale[bot]]

Hello 👋 Looks like there was no activity on this issue for last 90 days. Do you mind updating us on the status? Is this still reproducible or needed? If yes, just comment on this PR or push a commit. Thanks! 🤗 If there will be no activity for 60 days, this issue will be closed (we can always reopen an issue if we need!).

[MaryAyobami]

Hello @RyanZhaoXB is this issue still active? I'd love to work on it

[fisherxu]

@MaryAyobami Sure, still active, have you learned about KubeEdge?