You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by GitBox <gi...@apache.org> on 2022/05/22 08:24:46 UTC

[GitHub] [pulsar] asafm opened a new pull request, #15706: [fix][doc] Fixed wrong text in Full Transitive and Full Schema Compatibility docs

asafm opened a new pull request, #15706:
URL: https://github.com/apache/pulsar/pull/15706

   ### Modifications
   Fix wrong text in Full and Full Transitive schema compatibility 
   
   ### Verifying this change
   
   - [ ] Make sure that the change passes the CI checks.
   
   This change is a trivial rework / code cleanup without any test coverage.
   
   ### Documentation
   
   Check the box below or label this PR directly.
   
   Need to update docs? 
   
   - [ ] `doc-required` 
   (Your PR needs to update docs and you will update later)
     
   - [ ] `no-need-doc` 
   (Please explain why)
     
   - [ ] `doc` 
   (Your PR contains doc changes)
   
   - [ ] `doc-added`
   (Docs have been already added)


-- 
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: commits-unsubscribe@pulsar.apache.org

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


[GitHub] [pulsar] asafm commented on a diff in pull request #15706: [fix][doc] Fixed wrong text in Full Transitive and Full Schema Compatibility docs

Posted by GitBox <gi...@apache.org>.
asafm commented on code in PR #15706:
URL: https://github.com/apache/pulsar/pull/15706#discussion_r879405620


##########
site2/docs/schema-evolution-compatibility.md:
##########
@@ -193,13 +193,13 @@ The order of upgrading client applications is determined by the compatibility ch
 
 For example, the producers using schemas to write data to Pulsar and the consumers using schemas to read data from Pulsar. 
 
-|  Compatibility check strategy  |   Upgrade first  |   Description  | 
-| --- | --- | --- |
-|  `ALWAYS_COMPATIBLE`  |   Any order  |   The compatibility check is disabled. Consequently, you can upgrade the producers and consumers in **any order**.  | 
-|  `ALWAYS_INCOMPATIBLE`  |   None  |   The schema evolution is disabled.  | 
-|  <li>`BACKWARD` </li><li>`BACKWARD_TRANSITIVE` </li> |   Consumers  |   There is no guarantee that consumers using the old schema can read data produced using the new schema. Consequently, **upgrade all consumers first**, and then start producing new data.  | 
-|  <li>`FORWARD` </li><li>`FORWARD_TRANSITIVE` </li> |   Producers  |   There is no guarantee that consumers using the new schema can read data produced using the old schema. Consequently, **upgrade all producers first**<li>to use the new schema and ensure that the data already produced using the old schemas are not available to consumers, and then upgrade the consumers. </li> | 
-|  <li>`FULL` </li><li>`FULL_TRANSITIVE` </li> |   Any order  |   There is no guarantee that consumers using the old schema can read data produced using the new schema and consumers using the new schema can read data produced using the old schema. Consequently, you can upgrade the producers and consumers in **any order**.  | 
+|  Compatibility check strategy  |   Upgrade first  | Description                                                                                                                                                                                                                                                                                                         | 

Review Comment:
   Chang preview
   ![image](https://user-images.githubusercontent.com/989425/169820734-a90f87c9-8d59-48d9-a8f6-0148bc696bdf.png)
   



-- 
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: commits-unsubscribe@pulsar.apache.org

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


[GitHub] [pulsar] github-actions[bot] commented on pull request #15706: [fix][doc] Fixed wrong text in Full Transitive and Full Schema Compatibility docs

Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on PR #15706:
URL: https://github.com/apache/pulsar/pull/15706#issuecomment-1133843573

   @asafm:Thanks for your contribution. For this PR, do we need to update docs?
   (The [PR template contains info about doc](https://github.com/apache/pulsar/blob/master/.github/PULL_REQUEST_TEMPLATE.md#documentation), which helps others know more about the changes. Can you provide doc-related info in this and future PR descriptions? Thanks)


-- 
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: commits-unsubscribe@pulsar.apache.org

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


[GitHub] [pulsar] github-actions[bot] commented on pull request #15706: [fix][doc] Fixed wrong text in Full Transitive and Full Schema Compatibility docs

Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on PR #15706:
URL: https://github.com/apache/pulsar/pull/15706#issuecomment-1133843602

   @asafm:Thanks for providing doc info!


-- 
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: commits-unsubscribe@pulsar.apache.org

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


[GitHub] [pulsar] asafm commented on a diff in pull request #15706: [fix][doc] Fixed wrong text in Full Transitive and Full Schema Compatibility docs

Posted by GitBox <gi...@apache.org>.
asafm commented on code in PR #15706:
URL: https://github.com/apache/pulsar/pull/15706#discussion_r879401882


##########
site2/docs/schema-evolution-compatibility.md:
##########
@@ -119,10 +119,10 @@ Suppose that you have a topic containing three schemas (V1, V2, and V3), V1 is t
 
 Suppose that you have a topic containing three schemas (V1, V2, and V3), V1 is the oldest and V3 is the latest:
 
-| Compatibility check strategy | Definition | Description |
-|---|---|---|
-`FORWARD` | Consumers using the **last schema** can process data written by producers using a new schema, even though they may not be able to use the full capabilities of the new schema. | The consumers using the schema V3 or V2 can process data written by producers using the schema V3. |
-`FORWARD_TRANSITIVE` | Consumers using **all previous schemas** can process data written by producers using a new schema. | The consumers using the schema V3, V2, or V1 can process data written by producers using the schema V3. 
+| Compatibility check strategy | Definition                                                                                                                                                                     | Description                                                                                             |

Review Comment:
   Change preview
   ![image](https://user-images.githubusercontent.com/989425/169820124-b4b37655-63d0-4093-b01a-5d76a86efb13.png)
   



-- 
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: commits-unsubscribe@pulsar.apache.org

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


[GitHub] [pulsar] asafm commented on pull request #15706: [fix][doc] Fixed wrong text in Full Transitive and Full Schema Compatibility docs

Posted by GitBox <gi...@apache.org>.
asafm commented on PR #15706:
URL: https://github.com/apache/pulsar/pull/15706#issuecomment-1134623924

   > Hi @asafm please preview your changes locally and attach the preview screenshots in your PR description, steps: https://docs.google.com/document/d/1wszdtMRo6MhKbVaggPK7_bnKaC4TewuT--GWZZxJNGg/edit#
   
   @Anonymitaet, I've pasted screenshots for each change as comments in the PR next to the change


-- 
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: commits-unsubscribe@pulsar.apache.org

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


[GitHub] [pulsar] Anonymitaet merged pull request #15706: [fix][doc] Fixed wrong text in Full Transitive and Full Schema Compatibility docs

Posted by GitBox <gi...@apache.org>.
Anonymitaet merged PR #15706:
URL: https://github.com/apache/pulsar/pull/15706


-- 
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: commits-unsubscribe@pulsar.apache.org

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


[GitHub] [pulsar] asafm commented on a diff in pull request #15706: [fix][doc] Fixed wrong text in Full Transitive and Full Schema Compatibility docs

Posted by GitBox <gi...@apache.org>.
asafm commented on code in PR #15706:
URL: https://github.com/apache/pulsar/pull/15706#discussion_r879403668


##########
site2/docs/schema-evolution-compatibility.md:
##########
@@ -155,7 +155,7 @@ In some data formats, for example, Avro, you can define fields with default valu
 
 :::tip
 
-You can set schema compatibility check strategy at the topic, namespace or broker level. For how to set the strategy, see [here](schema-manage.md/#set-schema-compatibility-check-strategy).
+You can set schema compatibility check strategy at the topic, namespace or broker level. For how to set the strategy, see [here](schema-manage.md#set-schema-compatibility-check-strategy).

Review Comment:
   Preview
   ![image](https://user-images.githubusercontent.com/989425/169820359-5b58ac6e-bced-4de6-9189-975853b8004a.png)
   
   Leading to 
   ![image](https://user-images.githubusercontent.com/989425/169820411-e3b54875-e585-4f06-ab76-5b3188d3dc73.png)
   
   



-- 
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: commits-unsubscribe@pulsar.apache.org

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


[GitHub] [pulsar] codelipenghui commented on pull request #15706: [fix][doc] Fixed wrong text in Full Transitive and Full Schema Compatibility docs

Posted by GitBox <gi...@apache.org>.
codelipenghui commented on PR #15706:
URL: https://github.com/apache/pulsar/pull/15706#issuecomment-1134074733

   @Anonymitaet Please help review this PR. I noticed there are the format changes.


-- 
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: commits-unsubscribe@pulsar.apache.org

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


[GitHub] [pulsar] asafm commented on a diff in pull request #15706: [fix][doc] Fixed wrong text in Full Transitive and Full Schema Compatibility docs

Posted by GitBox <gi...@apache.org>.
asafm commented on code in PR #15706:
URL: https://github.com/apache/pulsar/pull/15706#discussion_r879400640


##########
site2/docs/schema-evolution-compatibility.md:
##########
@@ -96,10 +96,10 @@ Suppose that you have a topic containing three schemas (V1, V2, and V3), V1 is t
 
 Suppose that you have a topic containing three schemas (V1, V2, and V3), V1 is the oldest and V3 is the latest:
 
-| Compatibility check strategy | Definition  | Description |
-|---|---|---|
-`BACKWARD` | Consumers using the new schema can process data written by producers using the **last schema**. | The consumers using the schema V3 can process data written by producers using the schema V3 or V2. |
-`BACKWARD_TRANSITIVE` | Consumers using the new schema can process data written by producers using **all previous schemas**. | The consumers using the schema V3 can process data written by producers using the schema V3, V2, or V1. |
+| Compatibility check strategy | Definition                                                                                           | Description                                                                                             |

Review Comment:
   Change preview
   ![image](https://user-images.githubusercontent.com/989425/169819882-094410b3-6946-414b-96c6-3b322f2207ed.png)
   



-- 
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: commits-unsubscribe@pulsar.apache.org

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