Skip to content

Document optimization plan #1129

Open
Open
@EvenLjj

Description

@EvenLjj

Introduce

It has been more than three years since SOFARPC was open-sourced on April 10, 2018. RPC-related documents are mainly updated in June 2019. At that time, the document was relatively classic, and the core functions of RPC were introduced relatively clearly. However, with the iterative update of functions and the update of related components, according to the documents, we found that there are some areas that are not up to expectations. Many committees have also raised issues with problems that we have dealt with, and some may not have been dealt with. In order to have a better user experience, the previously scattered issues related to document optimization or document optimization can be collected and processed together. We have collected some common issues and plan to optimize them. At the same time, we hope to use the power of the community to work together to create a better SOFARPC. You can throw out here the problems you encounter when using the document. We will update the document optimization task from time to time in the follow-up. Welcome everyone to build together.

Optimization task

Registry

Configuration instructions


背景

SOFARPC 从2018年4月10号开源至今已经三年多了,RPC相关的文档主要还是2019年6月份更新的文档为主,当时文档编写的还是比较经典的,将RPC的核心功能都介绍的比较清楚。不过随着功能的迭代更新,以及关联组件的更新,目前根据接入文档发现有一些不达预期的地方,很多同学也将遇到的问题提了issue,有的我们处理了有的可能还没来得及处理。为了更好的用户体验,将之前零散的关于文档优化或者可以优化文档解决的issue集中到一起处理,我们收集了一些共性问题,打算着手优化下,同时也希望借助社区的力量一起共同打造更好的 SOFARPC。大家可以将平时按照文档使用时遇到问题在这里抛出来,后续我们会不定期更新下文档优化任务,欢迎大家一起共建。

优化任务

注册中心使用

配置说明

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentThe document was modifiedgood first issueGood for newcomershelp wantedExtra attention is neededremindTo be further discussed

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions