[jira] [Created] (KAFKA-4132) Make our upgrade docs more factual and less scary

["Gwen Shapira (JIRA)" <ji...@apache.org>]

Gwen Shapira created KAFKA-4132:
-----------------------------------

             Summary: Make our upgrade docs more factual and less scary
                 Key: KAFKA-4132
                 URL: https://issues.apache.org/jira/browse/KAFKA-4132
             Project: Kafka
          Issue Type: Improvement
          Components: documentation
            Reporter: Gwen Shapira


I got some feedback that our upgrade docs currently scare people away from upgrading Kafka. One reason is that the first line is "We have breaking changes!".

This was partially intentional (we were trying to scare people into reading docs), but I think we scared people into staying on older versions.

I think we need to break upgrade into two sections:

1. Upgrade section of design docs: should include our awesome backward compatibility story and highlight changes, new features and compelling bug fixes (breaking and non-breaking). It should also emphasize the important of following the upgrade docs to the letter.

2. The actual upgrade instructions should move to the Ops section of the docs.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)