[GitHub] [rocketmq-schema-registry] caigy commented on a diff in pull request #24: [docs] modify introduction and add some detail

[GitBox <gi...@apache.org>]

caigy commented on code in PR #24:
URL: https://github.com/apache/rocketmq-schema-registry/pull/24#discussion_r936174551


##########
README.md:
##########
@@ -20,21 +21,13 @@ It offers a variety of features:
 Getting started
 --------------
 
-#### Installation
-
-```shell
-$ git clone git@github.com:apache/rocketmq-schema-registry.git
-$ cd rocketmq-schema-registry
-$ mvn clean package
-```
-
 #### Prepare storage layer
 
-Currently, only RocketMQ is supported as the storage layer. And relies on the Compact Topic feature of RocketMQ 5.0,
-although previous versions can also be worked, but there is a risk of data loss if the machine disk fails. Similarly,
+Currently, Schema registry only support RocketMQ storage, and relies on the Compact Topic feature of RocketMQ-5.0.

Review Comment:
   'support' -> 'supports'



##########
README.md:
##########
@@ -51,24 +44,29 @@ $ nohup sh mqnamesrv &
 $ nohup sh mqbroker -n localhost:9876 &
 ```
 
-#### Edit configuration (Optional)
-
-* Config storage local cache path
+#### Install & Running locally
 
 ```shell
-$ echo "storage.local.cache.path=${user.dir}" >> storage-rocketmq/src/main/resources/rocketmq.properties
+$ git clone git@github.com:apache/rocketmq-schema-registry.git
+$ cd rocketmq-schema-registry
+$ mvn clean package
 ```
 
-#### Deployment & Running locally
-
 Take the build JAR in core/target/ and run `java -jar rocketmq-schema-registry-core-0.0.3-SNAPSHOT.jar` to start service.
 
 Then REST API can be accessed from http://localhost:8080/schema-registry/v1
 
 Swagger API documentation can be accessed from http://localhost:8080/swagger-ui/index.html
 
-Package management
---------------
+#### Customize configuration (Optional)

Review Comment:
   is it 'customized configurations'?



##########
README.md:
##########
@@ -20,21 +21,13 @@ It offers a variety of features:
 Getting started
 --------------
 
-#### Installation
-
-```shell
-$ git clone git@github.com:apache/rocketmq-schema-registry.git
-$ cd rocketmq-schema-registry
-$ mvn clean package
-```
-
 #### Prepare storage layer
 
-Currently, only RocketMQ is supported as the storage layer. And relies on the Compact Topic feature of RocketMQ 5.0,
-although previous versions can also be worked, but there is a risk of data loss if the machine disk fails. Similarly,
+Currently, Schema registry only support RocketMQ storage, and relies on the Compact Topic feature of RocketMQ-5.0.
+Previous rocketmq versions can also be worked, but there are some risk of data loss if the machine disk fails. 

Review Comment:
   'rocketmq' -> 'RocketMQ'



##########
README.md:
##########
@@ -119,6 +117,37 @@ $ curl -X GET http://localhost:8080/schema-registry/v1/cluster/{cluster-name}/te
 $ curl -X GET http://localhost:8080/schema-registry/v1/cluster/{cluster-name}/tenant/{tenant-name}/subject/{subject-name}/schema/versions
 ```
 
+Compatibility
+--------------
+Default compatibility is BACKWARD, which means that each change of Schema has no impact on the running programs. 
+Transitivity specifies the compatibility check scope for each change.
+
+| Compatible strategy | Permitted changes                 | Transitivity          | Upgrade order |
+|---------------------|-----------------------------------|-----------------------|---------------|
+| BACKWARD            | Delete fields Add optional fields | Last version          | Consumers     |
+| BACKWARD_TRANSITIVE | Delete fields Add optional fields | All previous versions | Consumers     |
+| FORWARD             | Add fields Delete optional fields | Last version          | Producers     |
+| FORWARD_TRANSITIVE  | Add fields Delete optional fields | All previous versions | Producers     |
+| FULL                | Modify optional fields            | Last version          | Any order     |
+| FULL_TRANSITIVE     | Modify optional fields            | All previous versions | Any order     |
+| NONE                | All changes are accepted          | Disabled              | Depends       |
+
+Architecture
+--------------
+
+Once Schema Registry enabled, the process for publish and subscribe will become to:

Review Comment:
   'the process for publishing and subscribing' may be more appropriate.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@rocketmq.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org