Skip to content

Commit

Permalink
docs: link to user docs (#1594)
Browse files Browse the repository at this point in the history
Signed-off-by: Alex Chi <[email protected]>
  • Loading branch information
skyzh authored Apr 6, 2022
1 parent d9014f4 commit 03030eb
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 0 deletions.
10 changes: 10 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Develop RisingWave

- [Develop RisingWave](#develop-risingwave)
- [Communication](#communication)
- [Setting Up Development Environment](#setting-up-development-environment)
- [Code Structure](#code-structure)
- [Start and Monitor a Dev Cluster](#start-and-monitor-a-dev-cluster)
Expand All @@ -23,6 +24,7 @@
- [Sending a PR](#sending-a-pr)
- [Pull Request Title](#pull-request-title)
- [Pull Request Description](#pull-request-description)
- [CLA](#cla)
- [Update CI Workflow](#update-ci-workflow)
- [When adding new files...](#when-adding-new-files)
- [When adding new dependencies...](#when-adding-new-dependencies)
Expand All @@ -31,6 +33,10 @@ Thanks for your interest in contributing to RisingWave! Contributions of many ki

If you have questions, please [create a Github issue](https://github.com/singularity-data/risingwave/issues/new/choose).

## Communication

RisingWave community is available on Slack. Please use the [invitation link](https://join.slack.com/t/risingwave-community/shared_invite/zt-120rft0mr-d8uGk3d~NZiZAQWPnElOfw) to join.

## Setting Up Development Environment

To contribute to RisingWave, the first thing is to set up the development environment. You'll need:
Expand Down Expand Up @@ -321,6 +327,10 @@ You may also check out our previous PRs in the [PR list](https://github.com/sing
- If your PR is small (such as a typo fix), you can go brief.
- If it is large and you have changed a lot, it's better to write more details.

### CLA

Contributors will need to sign Singularity Data's CLA.

## Update CI Workflow

We use scripts to generate GitHub Action configurations based on templates in `.github/workflow-template`.
Expand Down
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,12 @@
[![CI](https://github.com/singularity-data/risingwave/actions/workflows/main.yml/badge.svg)](https://github.com/singularity-data/risingwave/actions/workflows/main.yml)
[![codecov](https://codecov.io/gh/singularity-data/risingwave/branch/main/graph/badge.svg?token=EB44K9K38B)](https://codecov.io/gh/singularity-data/risingwave)

RisingWave is a cloud-native streaming database that uses SQL as the interface language. It is designed to reduce the complexity and cost of developing and using a stream processing platform so that developers can build applications more efficiently. It ingests streaming data, performs the processing that you specify (aggregates, joins, maps, enrichment, etc.), and dynamically updates the results. As a streaming database, RisingWave stores the results so that users can access them in real-time.

RisingWave ingests data from sources like Kafka, Apache Pulsar, Amazon Kinesis, Redpanda, and materialized CDC sources.

Learn more in [Introduction to RisingWave](https://singularity-data.com/risingwave-docs/docs/latest/intro/).

## Quick Start

### Installation
Expand Down Expand Up @@ -66,6 +72,10 @@ If everything works, you will see

in the Postgres shell.

## Documentation

You may refer to [RisingWave Docs](https://singularity-data.com/risingwave-docs/) for more information, such as architecture overview, how to create streaming source, etc.

## License

RisingWave is under the Apache 2.0 license. See the [LICENSE](LICENSE) file for details.
Expand Down

0 comments on commit 03030eb

Please sign in to comment.