Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

KSQL-473: point quickstart non-docker docs to release tarballs #601

Merged
merged 4 commits into from
Jan 16, 2018
Merged

KSQL-473: point quickstart non-docker docs to release tarballs #601

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
894906a
KSQL-473: point quickstart non-docker docs to release tarballs
rodesai Jan 5, 2018
491b60f
Move the doc links back inline
rodesai Jan 9, 2018
5585798
Merge branch 'master' into ksql_tgz
rodesai Jan 16, 2018
37c4b37
Remove git step
rodesai Jan 16, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Was it an intentional change to move the actual hyperlink to the bottom of the file? (same for two other changed links in here)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rodesai i would vote to keep this as-is. especially since the rest of the docs do not follow this convention.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Linking to the release-tagged docs from the master README.md, or moving the links down to the bottom of the markdown file?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rodesai i meant, not moving the links to the bottom. :)

- [Clickstream Analysis Demo][Demo]: Shows how to build an application that performs real-time user analytics.

# Use Cases and Examples

Expand Down Expand Up @@ -61,7 +61,7 @@ CREATE TABLE error_counts AS


# Documentation
You can [find the KSQL documentation here](/docs#ksql-documentation).
You can [find the KSQL documentation here][Documentation]

# Join the Community
Whether you need help, want to contribute, or are just looking for the latest news, you can find out how to [connect with your fellow Confluent community members here](https://www.confluent.io/contact-us-thank-you/).
Expand All @@ -79,3 +79,6 @@ The project is licensed under the Apache License, version 2.0.

*Apache, Apache Kafka, Kafka, and associated open source project names are trademarks of the [Apache Software Foundation](https://www.apache.org/).*

[Quick Start]: https://github.com/confluentinc/ksql/tree/v0.3/docs/quickstart#quick-start
[Demo]: https://github.com/confluentinc/ksql/tree/v0.3/ksql-clickstream-demo#clickstream-analysis
[Documentation]: https://github.com/confluentinc/ksql/tree/v0.3/docs#ksql-documentation
26 changes: 12 additions & 14 deletions docs/quickstart/quickstart-non-docker.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Copy link
Contributor

@joel-hamill joel-hamill Jan 9, 2018 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why remove Git as a prerequisite? isn't this still required down on line 48?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Its not needed to run KSQL using the release tarball.

- Java: Minimum version 1.8. Install Oracle Java JRE or JDK \>= 1.8 on your local machine

## Start Kafka
Expand Down Expand Up @@ -50,17 +48,19 @@ connect is [UP]
$ git clone git@github.com:confluentinc/ksql.git
```

1. Change directory to the `ksql` directory and compile the code.
1. Download the [KSQL 0.3 release tarball](https://s3-us-west-2.amazonaws.com/ksql-releases/releases/0.3/ksql.tgz).

1. Unpack the release tarball.

```bash
$ cd ksql
$ git checkout v0.3 -b 0.3
$ mvn clean compile install -DskipTests
$ tar -xzf ksql.tgz
```

> Tip: When using a Maven proxy or mirror, such as Artifactory, make sure that it is correctly configured to
> retrieve snapshot artifacts and access snapshot repositories. For more information, see
> [Could not find artifact](https://github.com/confluentinc/ksql/issues/537).
1. Change directory to the `ksql` directory.

```bash
$ cd ksql
```

1. Start KSQL. The `local` argument starts KSQL in [standalone mode](/docs/concepts.md#modes-of-operation).

Expand All @@ -82,20 +82,18 @@ Minimally, to use the [quick start exercises](/docs/quickstart#quick-start), you
1. Produce Kafka data to the `pageviews` topic using the data generator. The following example continuously generates data with a value in DELIMITED format.

```bash
$ java -jar ksql-examples/target/ksql-examples-4.1.0-SNAPSHOT-standalone.jar \
quickstart=pageviews format=delimited topic=pageviews maxInterval=10000
$ ./bin/ksql-datagen quickstart=pageviews format=delimited topic=pageviews maxInterval=10000
```

1. Produce Kafka data to the `users` topic using the data generator. The following example continuously generates data with a value in JSON format.

```bash
$ java -jar ksql-examples/target/ksql-examples-4.1.0-SNAPSHOT-standalone.jar \
quickstart=users format=json topic=users maxInterval=10000
$ ./bin/ksql-datagen quickstart=users format=json topic=users maxInterval=10000
```

Optionally, you can return to the [main KSQL quick start page](/docs/quickstart#quick-start) to start querying the Kafka cluster. Or you can do additional testing with topic data produced from the command line tools.

1. You can produce Kafka data with the Kafka command line `kafka-console-producer`. The following example generates data with a value in DELIMITED format.
1. You can produce Kafka data with the Kafka command line `kafka-console-producer` provided with the Confluent Platform. The following example generates data with a value in DELIMITED format.

```bash
$ kafka-console-producer --broker-list localhost:9092 \
Expand Down