sofastack / sofa-registry

SOFARegistry is a production-level, low-latency, high-availability service registry powered by Ant Financial.
https://www.sofastack.tech/sofa-registry/docs/Home
Apache License 2.0
651 stars 246 forks source link

[proposal] Test quickstart document in the github workflow #217

Open seeflood opened 2 years ago

seeflood commented 2 years ago

In what area(s)?

/area docs

Describe the feature

The quickstart document is important for new comers to know and play with our project. But keeping the doc up-to-date is not that easy. To make life easier, I wrote a tool mdx to "test" the quickstart documents in Layotto, and it found out lots of document issues and code bugs, see https://github.com/mosn/layotto/pull/456 image

I think we can test the sofa-registry quickstart too. For example, https://www.sofastack.tech/projects/sofa-registry/server-quick-start/

nobodyiam commented 2 years ago

Sounds like a good idea.