apolloconfig / apollo

Apollo is a reliable configuration management system suitable for microservice configuration management scenarios.
https://www.apolloconfig.com
Apache License 2.0
28.94k stars 10.19k forks source link

Add comment for clusters and UI display #5072

Closed BlackBear2003 closed 5 months ago

BlackBear2003 commented 5 months ago

What's the purpose of this PR

Add comment for clusters and UI display

Which issue(s) this PR fixes:

Fixes #https://github.com/apolloconfig/apollo/issues/5067

Brief changelog

it looks like:

WX20240108-215908@2x

image

Follow this checklist to help us incorporate your contribution quickly and easily:

codecov[bot] commented 5 months ago

Codecov Report

Attention: 7 lines in your changes are missing coverage. Please review.

Comparison is base (6657a58) 49.65% compared to head (8db44fa) 49.60%.

Files Patch % Lines
...com/ctrip/framework/apollo/biz/entity/Cluster.java 0.00% 4 Missing :warning:
.../ctrip/framework/apollo/common/dto/ClusterDTO.java 0.00% 3 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #5072 +/- ## ============================================ - Coverage 49.65% 49.60% -0.06% + Complexity 1905 1904 -1 ============================================ Files 372 372 Lines 11558 11564 +6 Branches 1127 1127 ============================================ - Hits 5739 5736 -3 - Misses 5478 5488 +10 + Partials 341 340 -1 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

nobodyiam commented 5 months ago

This looks great! Please find some comments below:

  1. I think the comment is similar to the remarks of namespace, so it's better to use the same term, e.g. Remarks and 备注 image image

  2. I think the comment should not be mandatory, as it's not a necessary information

  3. When displaying the comment, it's not necessary to display the prefix comment:

BlackBear2003 commented 5 months ago

I think the comment is similar to the remarks of namespace, so it's better to use the same term, e.g. Remarks and 备注

changed terms at front-end from 'comment' to 'remarks'.

I'm not sure should we change the sql and entity's field name? I see there is comment in AppNamespace, Commit and Item while there is not remarks. So I just use remark when UI display.

image image