Umbrella Issue for KubeEdge Documentation Improvement

[Shelley-BaoYue]

Description

Hello everyone, we made an update to the directory of the KubeEdge documentation recently. Our aim is to assist users and developers in the community to become more familiar with KubeEdge through the documentation. We summarized some tasks items as follows to complete or supplement the document content. Please comment with one or more items names if you are interested to join. Please feel free to tell us if you have any idea or suggestion.

Tasks

• Welcome
  • Getting Started (Complete the description of the documentation directory) -- @Shelley-BaoYue
  • Available Documentation Versions -- @Shelley-BaoYue
• Setup
  • Prerequisites/OS and Resources: List the supported OS and operation procedures
  • Prerequisites/Kubernetes: List compatible Kubernetes versions
  • Prerequisites/Container Runtime: List the supported edge runtimes and installation steps -- update container runtime docs #474 @Shelley-BaoYue
  • Install Tools/Keadm: Introduce Keadm including how to install Keadm, its sub-commands, and its compatible KubeEdge versions.
  • Install Tools/Keink: Introduce Keink and how to use it
  • Installing KubeEdge with Keadm: Optimize the current document -- @zhuyaguang
  • Installing KubeEdge Offline
  • Deploying HA CloudCore -- @ZhengXinwei-F
  • CloudCore && EdgeCore Config: Introduce the configuration
• Architecture
  • Optimize the existing modules(CloudHub, Edged, etc..) documentation
  • Add the introduction of modules listed as follows:
    • dynamiccontroller
    • synccontroller
    • router
• Core Concept
  • add the introduction of device IoT, including Mapper framework and DMI -- @wbc6080 update mapper and mapper-framework docs #475 update device crd docs #472
• Advanced Configuration
  • Optimize the document about 'Enable Kubectl logs/exec' with containerized deployment
  • Add operation guide of nodegroup and edgeapplications
  • Add operation guide of upgrading edgenodes remotely
  • How to manage devices
• Developer Guide
  • Optimize the existing documentations（build, testing and etc.）
  • add the introduction of how to manage devices -- @wbc6080 update dmi docs #471 update mapper and mapper-framework docs #475
  • how to use KubeEdge scripts of hack directory, such as using local-up-kubeedge.sh to start a local cluster, using make verify command to update vendor, using cherry_pick_pull.sh to cherry-pick a pr to other release branch.
• Community
  • Add release manager -- @Shelley-BaoYue @zhiyingfang2022
• FAQ
  • supply some frequently asked questions： add some runtime related faq #478

[wbc6080]

add the introduction of Mapper framework and DMI
add the introduction of how to manage devices
/assign @wbc6080

[zhuyaguang]

Installing KubeEdge with Keadm ，I'm very interested in this area，I am using keadm recently and hope to add configuration for CNI plug-in.

[Shelley-BaoYue]

Installing KubeEdge with Keadm ，I'm very interested in this area，I am using keadm recently and hope to add configuration for CNI plug-in.

Sorry for the delayed response. Thank you for your involvement. I will update this issue and add your name. You can start participating directly. Feel free if you have any questions.

[wbc6080]

I have add docs about Mapper and device api at Core Concept in #475 #472 , and add docs about DMI and Mapper Framework in #471 #475 @Shelley-BaoYue

[Shelley-BaoYue]

I have add docs about Mapper and device api at Core Concept in #475 #472 , and add docs about DMI and Mapper Framework in #471 #475 @Shelley-BaoYue

Thanks for your contributions! I have updated the issue status.

[anshikavashistha]

@Shelley-BaoYue I would be happy to know more about this project. What prerequisites are needed for applying to LFX mentorship program?

[Ayush9026]

@Shelley-BaoYue sir i am interested in this mentorship program.

[Himanshu-kiran]

@Shelley-BaoYue
Need to appreciate how project is structured and clear about its goal.
Happy to work and contribute!

[nikzayn]

Hey @Shelley-BaoYue, I am interested in this project to contribute to per LFX mentee project. I am excited to be a part of this project.

[techstacksavvy]

Hi @Shelley-BaoYue! I'd like to contribute but I'm unsure where to start. Are there any tasks here that you'd consider a "good first issue"? Thanks