-
Notifications
You must be signed in to change notification settings - Fork 635
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[ISSUE #4710] Rewrite the quick start guide for the home page. #4709
Conversation
How about linking this PR to a corresponding issue? |
Okay! |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #4709 +/- ##
============================================
+ Coverage 17.38% 17.60% +0.21%
- Complexity 1757 1775 +18
============================================
Files 797 797
Lines 29776 29786 +10
Branches 2573 2574 +1
============================================
+ Hits 5177 5243 +66
+ Misses 24121 24063 -58
- Partials 478 480 +2 ☔ View full report in Codecov by Sentry. |
This doc not finished yet, I'll convert it to draft till it ready to review. |
You may copy latest EventMesh Runtime documents (https://eventmesh.apache.org/zh/docs/instruction/runtime and https://eventmesh.apache.org/zh/docs/instruction/runtime-with-docker), imitating the README of Kafka and RocketMQ, removing redundant descriptions, and controlling the length of the README file. That will be good. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Well done, but adding the entire document is still not concise enough. The Quick Start section of RocketMQ is only 127 lines long. We don't configure RocketMQ so it can be further streamlined.
@Pil0tXia Done. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I didn't see changes corresponding to these two comments:
-
The suggestion of [ISSUE #4710] Rewrite the quick start guide for the home page. #4709 (comment)
-
[ISSUE #4710] Rewrite the quick start guide for the home page. #4709 (comment):
This narrative could be deleted.
Please add a new line between paragraph and code block when writting markdown.
I have already provided the correct version in the suggestion, which you can directly use.
Please note that I've deleted some lines in these two suggestions:
I suggest you directly copy the new changes in the suggestion code block. You can see the "Suggested Change" marker in the top left corner of the suggestion code block: Besides, once you have completed all the submissions, you can click "request for review" to notify me that the changes have been completed. |
I still haven't seen you remove the redundant narrative that I pointed out. Please refer to the following two comments. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, Good job.
Fixes #4710.
Motivation
Rewrite the quick start guide for the home page.
Add the operator's quick start step.
Modifications
Rewrite the quick start guide for the home page.
Add the operator's quick start step.
Documentation