Skip to content

Commit

Permalink
Revert commits which broke the docs (#501)
Browse files Browse the repository at this point in the history
* Revert "Make doc links point to GH repo (#496)"

This reverts commit 0371a08.

* Revert "DOCS-127 - Add KSQL doc to CP (#472)"

This reverts commit c488125.
  • Loading branch information
apurvam authored Dec 5, 2017
1 parent fe85aa2 commit 5bf0d5c
Show file tree
Hide file tree
Showing 30 changed files with 1,680 additions and 3,664 deletions.
14 changes: 5 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ Click here to watch a screencast of the KSQL demo on YouTube.
<a href="https://youtu.be/A45uRzJiv7I" target="_blank"><img src="screencast.jpg" alt="KSQL screencast"></a></p>
<!-- [![KSQL screencast](screencast.jpg)](https://youtu.be/A45uRzJiv7I) -->

# Getting Started
# Quick Start
If you are ready to see the power of KSQL, try out these:

- [KSQL Quick Start](/docs/quickstart/index.rst): Demonstrates a simple workflow using KSQL to write streaming queries against data in Kafka.
- [Clickstream Analysis Demo](/docs/ksql-clickstream-demo/index.rst): Shows how to build an application that performs real-time user analytics.
- [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.

# Use Cases and Examples

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


# Documentation
You can find the KSQL documentation at [docs.confluent.io](https://docs.confluent.io/current/ksql/docs/index.html). The source
is located in [https://github.com/confluentinc/ksql/docs/](/docs/).
You can [find the KSQL documentation here](/docs#ksql-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 @@ -71,13 +70,10 @@ Whether you need help, want to contribute, or are just looking for the latest ne
* Join the [Confluent Google group](https://groups.google.com/forum/#!forum/confluent-platform).

# Contributing
Contributions to the code, examples, documentation, etc, are very much appreciated. For more information, see the [contribution guidelines](contributing.md).
Contributions to the code, examples, documentation, etc, are very much appreciated. For more information, see the [contribution guidelines](/docs/contributing.md).

- Report issues and bugs directly in [this GitHub project](https://github.com/confluentinc/ksql/issues).

# Issues
Report issues in [this GitHub project](https://github.com/confluentinc/ksql/issues).

# License
The project is licensed under the Apache License, version 2.0.

Expand Down
181 changes: 0 additions & 181 deletions docs/Makefile

This file was deleted.

30 changes: 27 additions & 3 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,32 @@
# KSQL Documentation

The KSQL documentation is available on the Confluent Platform documentation site at [docs.confluent.io](https://docs.confluent.io/current/ksql/docs/index.html).
| Overview |[Quick Start](/docs/quickstart#quick-start) | [Concepts](/docs/concepts.md#concepts) | [Syntax Reference](/docs/syntax-reference.md#syntax-reference) |[Demo](/ksql-clickstream-demo#clickstream-analysis) | [Examples](/docs/examples.md#examples) | [FAQ](/docs/faq.md#frequently-asked-questions) | [Roadmap](/docs/roadmap.md#roadmap) |
|---|----|-----|----|----|----|----|----|

> *Important: This release is a **developer preview** and is free and open-source from Confluent under the Apache 2.0 license. Do not run KSQL against a production cluster.*
# Overview
KSQL is an open source streaming SQL engine that implements continuous, interactive queries against Apache Kafka™. It allows you to query, read, write, and process data in Apache Kafka in real-time, at scale using SQL commands. KSQL interacts directly with the [Kafka Streams API](https://kafka.apache.org/documentation/streams/), removing the requirement of building a Java app.

### Use cases
Common KSQL use cases are:

- Fraud detection - identify and act on out of the ordinary data to provide real-time awareness.
- Personalization - create real-time experiences and insight for end users driven by data.
- Notifications - build custom alerts and messages based on real-time data.
- Real-time Analytics - power real-time dashboards to understand what’s happening as it does.
- Sensor data and IoT - understand and deliver sensor data how and where it needs to be.
- Customer 360 - provide a clear, real-time understanding of your customers across every interaction.

KSQL lowers the barriers for using real-time data in your applications. It is powered by a scalable streaming platform without the learning curve or additional management complexity of other stream processing solutions.

## Modes of operation

You can use KSQL in standalone, client-server, application, and embedded modes. See [Concepts](/docs/concepts.md#concepts) for more information.

## Getting Started

* Beginners: Try the [interactive quick start](/docs/quickstart#quick-start). The quick start configures a single instance in a lightweight Docker container or in a Kafka cluster. It demonstrates a simple workflow using KSQL to write streaming queries against data in Kafka.
* Advanced users: Try the [end-to-end Clickstream Analysis demo](/ksql-clickstream-demo#clickstream-analysis).

# Contributing

This documentation is built using [Sphinx](http://sphinx-doc.org). For information on how to contribute, see the [contributing guidelines](contributing.md).
Loading

0 comments on commit 5bf0d5c

Please sign in to comment.