Skip to content
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

Merged
merged 36 commits into from
Jan 14, 2024

Conversation

Alonexc
Copy link
Contributor

@Alonexc Alonexc commented Jan 2, 2024

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

  • Does this pull request introduce a new feature? no

@Alonexc Alonexc changed the title Add eventmesh- operator quick start document link to the home page. Add eventmesh-operator quick start document link to the home page. Jan 2, 2024
Pil0tXia
Pil0tXia previously approved these changes Jan 2, 2024
@Pil0tXia
Copy link
Member

Pil0tXia commented Jan 2, 2024

How about linking this PR to a corresponding issue?

@Alonexc
Copy link
Contributor Author

Alonexc commented Jan 2, 2024

How about linking this PR to a corresponding issue?

Okay!

@Alonexc Alonexc changed the title Add eventmesh-operator quick start document link to the home page. [ISSUE #4710] Add eventmesh-operator quick start document link to the home page. Jan 2, 2024
Copy link

codecov bot commented Jan 2, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (87ed40d) 17.38% compared to head (f56674a) 17.60%.
Report is 36 commits behind head on master.

❗ Current head f56674a differs from pull request most recent head 107c512. Consider uploading reports for the commit 107c512 to get more accurate results

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.
📢 Have feedback on the report? Share it here.

pandaapo
pandaapo previously approved these changes Jan 2, 2024
@xwm1992 xwm1992 marked this pull request as draft January 3, 2024 02:53
@xwm1992
Copy link
Contributor

xwm1992 commented Jan 3, 2024

This doc not finished yet, I'll convert it to draft till it ready to review.

@Alonexc Alonexc marked this pull request as ready for review January 5, 2024 07:14
@Alonexc Alonexc changed the title [ISSUE #4710] Add eventmesh-operator quick start document link to the home page. [ISSUE #4710] Rewrite the quick start guide for the home page. Jan 5, 2024
README.zh-CN.md Outdated Show resolved Hide resolved
README.zh-CN.md Outdated Show resolved Hide resolved
@Pil0tXia
Copy link
Member

Pil0tXia commented Jan 10, 2024

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.

Copy link
Member

@Pil0tXia Pil0tXia left a 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.

README.zh-CN.md Outdated Show resolved Hide resolved
README.zh-CN.md Outdated Show resolved Hide resolved
README.zh-CN.md Outdated Show resolved Hide resolved
README.zh-CN.md Outdated Show resolved Hide resolved
README.zh-CN.md Outdated Show resolved Hide resolved
README.zh-CN.md Outdated Show resolved Hide resolved
@Alonexc
Copy link
Contributor Author

Alonexc commented Jan 11, 2024

@Pil0tXia Done.

Copy link
Member

@Pil0tXia Pil0tXia left a 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:

  1. The suggestion of [ISSUE #4710] Rewrite the quick start guide for the home page. #4709 (comment)

  2. [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.

README.zh-CN.md Outdated Show resolved Hide resolved
@Pil0tXia
Copy link
Member

Pil0tXia commented Jan 11, 2024

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:

image

Besides, once you have completed all the submissions, you can click "request for review" to notify me that the changes have been completed.

@Alonexc Alonexc requested a review from Pil0tXia January 11, 2024 09:28
@Pil0tXia
Copy link
Member

I still haven't seen you remove the redundant narrative that I pointed out. Please refer to the following two comments.

README.md Outdated Show resolved Hide resolved
Copy link
Member

@Pil0tXia Pil0tXia left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, Good job.

@xwm1992 xwm1992 merged commit e837f34 into apache:master Jan 14, 2024
7 of 11 checks passed
@Alonexc Alonexc deleted the doc branch January 15, 2024 01:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Doc] Rewrite quick start and add operator deployment steps.
4 participants