KSQL-473: point quickstart non-docker docs to release tarballs #601
Conversation
Point the quickstart non-docker instructions to the release tarball on s3. Release tarballs are manually generated and uploaded to the ksql-releases s3 bucket. This change also updates the instructions accordingly. Point the main readme to the release-tagged documentation.
rodesai
requested review from
miguno,
bluemonk3y,
joel-hamill,
hjafarpour and
aayars
README.md
Outdated
| @@ -11,8 +11,8 @@ Click here to watch a screencast of the KSQL demo on YouTube. | |||
| # Quick Start | |||
| If you are ready to see the power of KSQL, try out these: | |||
|
|
|||
| - [KSQL Quick Start](/docs/quickstart#quick-start): Demonstrates a simple workflow using KSQL to write streaming queries against data in Kafka. | |||
| - [Clickstream Analysis Demo](/ksql-clickstream-demo#clickstream-analysis): Shows how to build an application that performs real-time user analytics. | |||
| - [KSQL Quick Start][Quick Start]: Demonstrates a simple workflow using KSQL to write streaming queries against data in Kafka. | |||
There was a problem hiding this comment.
Was it an intentional change to move the actual hyperlink to the bottom of the file? (same for two other changed links in here)
There was a problem hiding this comment.
Yeah - I wanted all the links that would need to be updated on release to be grouped together so its less likely one gets missed.
There was a problem hiding this comment.
@rodesai i would vote to keep this as-is. especially since the rest of the docs do not follow this convention.
There was a problem hiding this comment.
Linking to the release-tagged docs from the master README.md, or moving the links down to the bottom of the markdown file?
There was a problem hiding this comment.
@rodesai i meant, not moving the links to the bottom. :)
| @@ -15,8 +15,6 @@ This part of the quick start will guide you through the steps to setup a Kafka c | |||
| - KSQL is in developer preview. Do not run KSQL against a production cluster. | |||
| - [Confluent Platform 4.0.0](http://docs.confluent.io/current/installation.html) is installed. This installation includes a Kafka broker, ZooKeeper, Schema Registry, REST Proxy, and Kafka Connect. | |||
| - If you installed Confluent Platform via tar or zip, navigate into the installation directory. The paths and commands used throughout this quick start assume that your are in this installation directory. | |||
| - [Maven](https://maven.apache.org/install.html) | |||
| - [Git](https://git-scm.com/downloads) | |||
There was a problem hiding this comment.
why remove Git as a prerequisite? isn't this still required down on line 48?
There was a problem hiding this comment.
Its not needed to run KSQL using the release tarball.
Point the quickstart non-docker instructions to the release tarball
on s3. Release tarballs are manually generated and uploaded to the
ksql-releases s3 bucket. This change also updates the instructions
accordingly.
Point the main readme to the release-tagged documentation.